Python command line application bare bones template.
Project description
This is a structure template for Python command line applications, ready to be released and distributed via setuptools/PyPI/pip for Python 2 and 3.
Please have a look at the corresponding article: http://gehrcke.de/2014/02/distributing-a-python-command-line-application/
Usage
Clone this repository and adopt the bootstrap structure for your own project. This is just a starting point, but I hope a good one. From there on, you should read and follow http://python-packaging-user-guide.readthedocs.org/en/latest/, the definite resource on Python packaging.
Behavior
Flexible invocation
The application can be run right from the source directory, in two different ways:
Treating the bootstrap directory as a package and as the main script:
$ python -m bootstrap arg1 arg2 Executing bootstrap version 0.2.0. List of argument strings: ['arg1', 'arg2'] Stuff and Boo(): <class 'bootstrap.stuff.Stuff'> <bootstrap.bootstrap.Boo object at 0x7f43d9f65a90>
Using the bootstrap-runner.py wrapper:
$ ./bootstrap-runner.py arg1 arg2 Executing bootstrap version 0.2.0. List of argument strings: ['arg1', 'arg2'] Stuff and Boo(): <class 'bootstrap.stuff.Stuff'> <bootstrap.bootstrap.Boo object at 0x7f149554ead0>
Installation sets up bootstrap command
Situation before installation:
$ bootstrap bash: bootstrap: command not found
Installation right from the source tree (or via pip from PyPI):
$ python setup.py install
Now, the bootstrap command is available:
$ bootstrap arg1 arg2 Executing bootstrap version 0.2.0. List of argument strings: ['arg1', 'arg2'] Stuff and Boo(): <class 'bootstrap.stuff.Stuff'> <bootstrap.bootstrap.Boo object at 0x7f366749a190>
On Unix-like systems, the installation places a bootstrap script into a centralized bin directory, which should be in your PATH. On Windows, bootstrap.exe is placed into a centralized Scripts directory which should also be in your PATH.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file cmdline-bootstrap-0.2.0.tar.gz
.
File metadata
- Download URL: cmdline-bootstrap-0.2.0.tar.gz
- Upload date:
- Size: 2.6 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | a0bc9ad02fe2b36141bf43eb160e01e35f810780317661fd719846fd45af73c2 |
|
MD5 | f538eea8049d628815d372dd2a62046c |
|
BLAKE2b-256 | d2463d8807e7fdb5d4f76972985cbfef39c3f039f8fbd37df62b18bdd547337c |