pytemplate

This is a Python 3.11 app called pytemplate. The project includes Docker, Pyright, Ruff, GitHub Actions, Black, pre-commit, and Sphinx.

Project Structure

Project Structure

The project structure is as follows:

pytemplate
├── .dockerignore
├── .github
│   ├── dependabot.yml
│   └── workflows
│       └── python-app.yml
├── .gitignore
├── .pre-commit-config.yaml
├── Dockerfile
├── Makefile
├── README.md
├── docs
│   ├── Makefile
│   └── source
│       ├── conf.py
│       └── index.rst
├── pyproject.toml
├── pytemplate
│   ├── __init__.py
│   ├── main.py
│   └── utils.py
├── requirements.txt
├── ruff.toml
└── tests
    ├── test_main.py
    └── test_utils.py

The source code is located in the pytemplate folder, which contains the __init__.py, main.py, and utils.py files. The tests are located in the tests folder, which contains the test_main.py and test_utils.py files.

The project uses toml for configuration instead of setup.py. The configuration file is located in pyproject.toml.

The project includes Docker, with a Dockerfile located in the root directory. The .dockerignore file is also located in the root directory.

The project includes Pyright for static type checking, pre-commit for code formatting, Black for code formatting and Ruff for linting. The configuration for these tools is located in the .pre-commit-config.yaml and ruff.toml files.

The project includes Sphinx for documentation, with the documentation located in the docs folder. The source/conf.py file contains the configuration for Sphinx.

The project includes GitHub Actions for continuous integration, with the configuration located in the .github/workflows/python-app.yml file.

Usage Notes

• Replace all mentions of "pytemplate" to your own project's name.
• Edit .github/workflows/python-app.yml to configure which triggers and jobs to enable/disable.

Installation

To install the project, clone the repository and run:

python -m venv .venv
source .venv/bin/activate
pip install -U pip setuptools
pip install -r requirements.txt
pre-commit install

Then install the project using:

pip install -e .

See Makefile for other useful commands.

Testing

Just issue pytest from the root directory.