Python App Template

Table of Contents

• Installing
• Using
• Contributing

A Python app that reticulates splines.

Installing

To install this package, run:

pip install python-app-template

Alternatively, if you are developing the project, install its dependencies with Poetry:

poetry install

Using

To view the CLI help information, run:

python-app-template --help

Contributing

Development environments

The following development environments are supported:

1. ⭐️ GitHub Codespaces: Click on Open in GitHub Codespaces to start developing in your browser.

2. ⭐️ Poetry: Clone this repository and run the following from the root of the repository:

   # Install project dependencies
   poetry install
   
   # Activate the virtual environment
   source ./activate.sh
   
   # Install the pre-commit hooks
   task pre-commit:init

3. PyCharm Dev Container: Clone this repository, open it with PyCharm, create a Dev Container with Mount Sources, and configure an existing Python interpreter at /opt/venv/bin/python.

Developing

• This project follows the Conventional Commits standard to automate Semantic Versioning and Keep A Changelog with Commitizen.
• Run poe from within the development environment to print a list of Poe the Poet tasks available to run on this project.
• Run poetry add {package} from within the development environment to install a runtime dependency and add it to pyproject.toml. Add --dev to install a development dependency.
• Run poetry update to upgrade all dependencies to the latest versions allowed by pyproject.toml.
• Run cz bump to bump the app's version, update the CHANGELOG.md, and create a git tag. Then push the changes and the git tag with git push origin main --tags.