python-skeleton-project

python-skeleton-project is a barebones repository intended as a quick-start for new python applications which plan to utilize the following functionalities:

• Unit testing with pytest
• Continuous integration testing with Github Actions
• Containerization via Docker
• Packaging and publishing to PyPi
• Documentation with Sphinx and Github Pages

Documentation

Documentation can be found here via Github Pages.

Dependencies

python-skeleton-project is tested to work under Python 3.x. See the requirements via the following command:

cat requirements.txt

Installation

Simply use pip:

pip install -U python-skeleton-project
# or
pip install .

Testing

Docker

make test