Here we provide some details about the project setup. Most of the choices are explained in the guide. Links to the relevant sections are included below. Feel free to remove this text when the development of the software package takes off.
For a quick reference on software development, we refer to the software guide checklist.
This repository is set up with Python versions:
- 3.10
- 3.11
- 3.12
Add or remove Python versions based on project requirements. See the guide for more information about Python versions.
You can use either pip or conda for installing dependencies and package management. This repository does not force you to use one or the other, as project requirements differ. For advice on what to use, please check the relevant section of the guide.
- Runtime dependencies should be added to
pyproject.tomlin thedependencieslist under[project]. - Development dependencies, such as for testing or documentation, should be added to
pyproject.tomlin one of the lists under[project.optional-dependencies].
You can distribute your code using PyPI. The guide can help you decide which tool to use for packaging.
- Tests should be put in the
testsfolder. - The
testsfolder contains:- Example tests that you should replace with your own meaningful tests (file:
test_my_module.py)
- Example tests that you should replace with your own meaningful tests (file:
- The testing framework used is PyTest
- PyTest introduction
- PyTest is listed as a development dependency
- This is configured in
pyproject.toml
- The project uses GitHub action workflows to automatically run tests on GitHub infrastructure against multiple Python versions
- Workflows can be found in
.github/workflows
- Workflows can be found in
- Relevant section in the guide
- Documentation should be put in the
docs/directory. The contents have been generated usingsphinx-quickstart(Sphinx version 1.6.5). - We recommend writing the documentation using Restructured Text (reST) and Google style docstrings.
- The documentation is set up with the ReadTheDocs Sphinx theme.
- Check out its configuration options.
- AutoAPI is used to generate documentation for the package Python objects.
.readthedocs.yamlis the ReadTheDocs configuration file. When ReadTheDocs is building the documentation this package and its development dependencies are installed so the API reference can be rendered.- Relevant section in the guide
Sonarcloud is used to perform quality analysis and code coverage report
sonar-project.propertiesis the SonarCloud configuration file.github/workflows/sonarcloud.ymlis the GitHub action workflow which performs the SonarCloud analysis
- We recommend using semantic versioning.
- For convenience, the package version is stored in a single place:
pyproject.tomlunder thetool.bumpversionheader. - Don't forget to update the version number before making a release!
- We recommend using the logging module for getting useful information from your module (instead of using print).
- The project is set up with a logging example.
- Relevant section in the guide
- Document changes to your software package
- Relevant section in the guide
- To allow others to cite your software, add a
CITATION.cfffile - It only makes sense to do this once there is something to cite (e.g., a software release with a DOI).
- Follow the making software citable section in the guide.
- Information about how to behave professionally
- Relevant section in the guide
- Information about how to contribute to this software package
- Relevant section in the guide
- List non-Python files that should be included in a source distribution
- Relevant section in the guide
- List of attributions of this project and Apache-license dependencies
- Relevant section in the guide