Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 2.16 KB

README.md

File metadata and controls

42 lines (33 loc) · 2.16 KB
Raw

Ruff Code style: black Imports: isort codecov tests doc

template-python

Package

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 and all the template entries
  • Edit the GitHub workflows in .github
  • Enable pre-commit.ci on https://pre-commit.ci/
  • Edit README.md
  • Edit MANIFEST.in
  • Edit the package import in tools/stubgen.py
  • 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).

Documentation build

If the documentation build is preserved, the following steps are required:

On the main branch:

  • Edit the project links in doc\links.inc
  • Edit the landing page index.rst
  • Edit the sphinx configuration doc/conf.py
  • Edit the API pages
    • In doc\api\index.rst, edit the package name
    • In doc\api\logging.rst, edit the current module
  • 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