Skip to main content

A skeleton command line program in Python.

Project description

A skeleton command line program in Python.

Purpose

This is a skeleton application which demonstrates how to properly structure a Python CLI application.

I’ve done my best to structure this in a way that makes sense for most users, but if you have any feedback, please open a Github issue and I’ll take a look.

The idea with this project is that you should be able to use this as a template for building new CLI apps.

You can fork this project and customize it to your liking, or just use it as a reference.

Usage

If you’ve cloned this project, and want to install the library (and all development dependencies), the command you’ll want to run is:

$ pip install -e .[test]

If you’d like to run all tests for this project (assuming you’ve written some), you would run the following command:

$ python setup.py test

This will trigger py.test, along with its popular coverage plugin.

Lastly, if you’d like to cut a new release of this CLI tool, and publish it to the Python Package Index (PyPI), you can do so by running:

$ python setup.py sdist bdist_wheel
$ twine upload dist/*

This will build both a source tarball of your CLI tool, as well as a newer wheel build (and this will, by default, run on all platforms).

The twine upload command (which requires you to install the twine tool) will then securely upload your new package to PyPI so everyone in the world can use it!

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

skele-1.0.0.tar.gz (4.7 kB view details)

Uploaded Source

Built Distribution

skele-1.0.0-py2.py3-none-any.whl (5.9 kB view details)

Uploaded Python 2Python 3

File details

Details for the file skele-1.0.0.tar.gz.

File metadata

  • Download URL: skele-1.0.0.tar.gz
  • Upload date:
  • Size: 4.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No

File hashes

Hashes for skele-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e6c3a0d77e9fa9e7060cf2b4e4462318076948b1ee890ac2849de3615dd4c221
MD5 58594ea3a7e11d173de1e421c7bcd6bf
BLAKE2b-256 32b1a0cb40e10b3a9f3bd589e0ddbf6524c051b8b0de8b37aaac942ae37bef3d

See more details on using hashes here.

File details

Details for the file skele-1.0.0-py2.py3-none-any.whl.

File metadata

File hashes

Hashes for skele-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 61a278a934b1e5632df981aa4e376b11b275f6f9a0477615676bfa9c5ff798a3
MD5 16e534676bb3af85d357d6daabc2092a
BLAKE2b-256 9d749dabc8a6d48341728deb9c0aea65a48d5c21433bf8230a59367496d7bb88

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page