Template python repository. To bootstrap a project from this template, the following steps are required:
- Rename the folder
template
to the package name - Edit
pyproject.toml
- Under
[project]
, editname
,description
andkeywords
- Under
[project.optional-dependencies]
, edit the extra-keysall
andfull
- Under
[project.urls]
, edit all the URLs - Under
[project.scripts]
, edit the command for system information - Under
[tool.setuptools.packages.find]
, edit the file inclusion/exclusion patterns - Under
[tool.pydocstyle]
, edit the matching patternmatch-dir
- Under
[tool.coverage.run]
, edit the exclusion patternsomit
- Under
- Edit the GitHub workflows
- In
doc.yaml
, edit the command for system information - In
publish.yaml
, uncomment the trigger on release and edit the command for system information - In
pytest.yaml
, edit the commands for system information and pytest
- In
- Edit the pre-commit configuration
- Edit the paths in
.pre-commit-config.yaml
- Enable
pre-commit.ci
on https://pre-commit.ci/
- Edit the paths in
- Edit
README.md
- Edit
MANIFEST.in
- Edit the keys to list in the system information
- Remove the conda-forge recipe from the ignored files in
.yamllint.yaml
The package can then be installed in a given environment with
pip install -e .
(assuming the current working directory is the root of the
repository).
If the documentation build is preserved, the following steps are required:
On the main
branch:
- Edit the GitHub workflows
- In
doc.yaml
, edit the command for system information
- In
- Edit the project links in
doc\links.inc
- Edit the landing page
index.rst
- Edit the sphinx configuration
- Replace
import template
with the correct package name - Edit the fields
project
,author
,release
,package
andgh_url
- Replace
- Edit the API pages
- In
doc\api\index.rst
, edit the package name - In
doc\api\logging.rst
, edit the current module
- In
- Edit the logging tutorial to replace
from template import
with the correct package name
On the gh-pages
branch:
- Edit the links in the landing page
index.html