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-test-1.0.0.tar.gz (4.6 kB view details)

Uploaded Source

Built Distribution

skele_test-1.0.0-py2.py3-none-any.whl (5.8 kB view details)

Uploaded Python 2Python 3

File details

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

File metadata

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

File hashes

Hashes for skele-test-1.0.0.tar.gz
Algorithm Hash digest
SHA256 e13d319d8fe4629d87307f0397176a613500aa0c0eecbb56a22f78982e1beca6
MD5 4ad47c070f887fb784444a925d8e68a5
BLAKE2b-256 872cc26dab45b6c7a078d3fc8880d824e2c14c572a3731e2b174655efbe7a77e

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for skele_test-1.0.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 fa2be5f61a21fd646603c20add7a4796bd58f7e598444b8b50a8d28a8fe8d3a2
MD5 3ecd78639cb8ee5c4d70c5532f1ccee4
BLAKE2b-256 175355cd268af9d64eee3dbf02ab41c285e336225e7e57aead28f841b0958d22

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