Python3 CLI template

Project tagline goes here.

Contents of this document

• Description
• Installation
• Documentation
  • API documentation
  • Usage
• Contributing to the project
  • Installation
  • Testing
  • Generating documentation
• Versioning
• Author
• License

Description

Project description goes here.

Installation

Use the following commands to install the program:

sudo apt-get install python3-pip
git clone https://github.com/stepgazaille/python3-cli-template.git
cd python3-cli-template
sudo pip3 install .

Documentation

API documentation

The API documentation is hosted on GitHub Pages

Usage

usage: program-cli [-h] [-o OPTIONAL] mandatory

program -- program description

Created by John Doe on 2016-09-03.
Copyright 2016. All rights reserved.

Licensed under the Apache License 2.0
http://www.apache.org/licenses/LICENSE-2.0

Distributed on an "AS IS" basis without warranties
or conditions of any kind, either express or implied.

USAGE

positional arguments:
  mandatory             A mandatory argument.

optional arguments:
  -h, --help            show this help message and exit
  -o OPTIONAL, --optional OPTIONAL
                        an optional argument

Usage examples

Use case no 1:

program-cli "mandatory argument"

Use case no 2:

program-cli "mandatory argument" -o "optional argument"

Contributing to the project

Installation

Use the following command to install testing and documentation dependencies:

sudo pip3 install -r requirements.txt

Use the following commands to install the program in editable mode:

git clone https://github.com/stepgazaille/python3-cli-template.git
cd python3-cli-template
sudo pip3 install -e .

Testing

Style checker

We are using pep8 for style checking. Use the following command to check style:

pep8 .

Bad code smells

We are using pylint to catch bad code smells. Use the following command to catch bad code smells:

pylint ./program/

Unit testing

We are using nose2 for unit testing. Use the following command to run unit tests:

nose2

End-to-end testing

Use the following command to run end-to-end tests:

python3 ./tests/end_to_end_test.py

Generating documentation

We are using Sphinx to generate our API documentation. Use the following commands to generate a local version of the project's API documentation:

cd docs
make clean; make html

The generated API documentation will appear in docs/_build/html/ directory.

Versioning

We are using SemVer for versioning. For the versions available, see the tags on this repository

Author

• Stephane Gazaille - Initial work

License

This project is licensed under the Apache License Version 2.0. See LICENSE for details