This is a public fork of the cookiecutter template used for the Python projects at voraus robotik. Projects are created and updated via cruft.
Create a new virtual environment and install necessary dependencies.
python3.11 -m venv venv
source venv/bin/activate
pip install cruft isort black cookiecutter==2.5.0
Create a new project with
cruft create git@github.com:vorausrobotik/voraus-python-template.git
and follow the prompts. The template will ask you for a name and email address to use for the maintainer of the project (the name and email address of your active Git profile is used by default). Unless you know what you are doing, you should define a project name, e.g., "voraus Robot Library", and go with the proposed default values. Cruft uses cookiecutter behind the scenes to generate the project.
Cruft helps with updating projects that were originally created from a template.
Run cruft check to check whether the project is out of sync with the template.
Run cruft update to update the project.
The update is performed by looking at the template branch that is specified as checkout in the cruft.json.
Python projects created with the template come pre-configured with an extensive CI pipeline.
tox makes it easy to run the full CI pipeline on your local machine. The minimal setup to develop your package is to create a virtual environment and install the package and its runtime requirements:
python3.9 -m venv venv
source venv/bin/activate
pip install --upgrade pip
pip install -e .[dev]
Run tox run to execute the test pipeline. The tox pipelines are configured in the tox.ini file. Configurations for specific tools in the pipeline are maintained in the pyproject.toml file. tox is configured to create its own virtual environments, install test dependencies and the package you are developing, and run all tests. If you want to perform a clean run for some reason, you can run tox run -r to recreate tox's virtual environment.
The following tools are part of the test pipeline:
isort: Automatically sorts your imports.
black: Automatically and deterministically formats your code.
mypy: Statically checks your type hints.
pylint: Statically checks your code for errors and code smells.
pytest: Provides a framework for unit tests. Also doc-tests your docstrings and collects coverage information via pytest-cov.
pydocstyle: Checks your docstring style. Use Google style docstrings.
If you don’t want to run the whole test pipeline, you can also use single commands from the pipeline, e.g., pytest.
The tools will automatically pick up the correct configuration from the pyproject.toml file.
Run tox -e docs to build your documentation with Sphinx straight from your code.
You can add additional documentation inside the docs/ folder.
The pipeline also runs doctests that you added in the documentation (.rst files).
Doctests inside your code's docstrings are executed by pytest.
The Sphinx-native autodoc extension converts Python docstrings to RST.
It imports the modules to be documented.
If any modules have side effects on import, these will be executed by autodoc when sphinx-build is run.
Scripts (as opposed to library modules) must therefore be protected by an if __name__ == '__main__' condition.
Run tox -e build to build your package.
You need to make the desired changes in the template.
Don't accidentally make your changes in the generated project because those changes will be overridden again.
Commit your changes so that they are used for the template generation in the next steps.
Non-committed changes won't be added to the template!
Run tox run to use the template to generate the sample package with your new changes.
Change into the generated folder and run tox run, tox run -e docs, and tox run -e build to check that your changes
work with the sample package.
(Amend-)commit again and push all changes.
This project is licensed under the MIT License.