Skip to main content

PipApp creates directories and files for Pip-distributable Python application.

Inspired by no-nonsense blog post about Python application distribution (https://gehrcke.de/2014/02/distributing-a-python-command-line-application/).

Requirements

Python 3.

Install

Install latest version: pip install pipapp.

Usage

Execute

pipapp [PROJECTNAME]

and basic set of files and directories (as descibed in no-nonsense blog post) are automagically created in ./PROJECTNAME directory. The main source file is PROJECTNAME.py in ./PROJECTNAME/PROJECTNAME directory. PipApp is not used after initial creation of directories and files, so you can go ahead and develop, register with PyPi and upload the application to PyPi.

If current directory is not good, you can specify directory where to create files and dirs:

-d DIR, --dir DIR  Root directory where to create new project files and dirs. Default is current directory.

For example, if you execute pipapp hobbyproject, you get following directories and files in your current directory:

hobbyproject/
├── CHANGES
├── hobbyproject
│   ├── __init__.py
│   ├── __main__.py
│   └── hobbyproject.py
├── hobbyproject-runner.py
├── LICENSE
├── MANIFEST.in
├── README.rst
├── setup.cfg
└── setup.py

When first executing the script a file $HOME/.pipapp_defaults is created. The file includes some configuration items such as author name and email and set of classifiers to be used in generated setup.py.

About

PipApp is meant to give quick start to develop pip-distributable Python applications by providing basic set of files and directories. Currently basic set is enough and if you need more professional style of working, please see https://www.jeffknupp.com/blog/2013/08/16/open-sourcing-a-python-project-the-right-way/.

Metadata

Release files for pipapp 0.4

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pipapp 0.4
File Size Uploaded
pipapp-0.4.tar.gz 5.5 kB Details

Release files / pipapp-0.4.tar.gz

Download URL pipapp-0.4.tar.gz
Size 5.5 kB
Tags Source
SHA-256 checksum
How to use checksums
b99712a039692da3e1b345376d8a7d216052861c6179e9abc1936805f7d33149
BLAKE2b-256 checksum
How to use checksums
7ee166a7150a44562a3b2e73124e5a44678cf398e014941dee7fa8ab452d2bfb
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No

Release history Release notifications | RSS feed

This release

0.4 This release

1 release file

0.3

1 release file

0.2

1 release file

0.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page