mscheltienne/template-python
1
0
Fork 0
mirror of https://github.com/mscheltienne/template-python.git synced 2026-06-11 08:39:34 +00:00
Code Issues Projects Releases Packages Wiki Activity
Template python repository. https://mscheltienne.github.io/template-python/
655 commits 2 branches 31 tags 5.7 MiB
  • Python 100%
Find a file
Exact
pre-commit-ci[bot] de1ee1c852
 [pre-commit.ci] pre-commit autoupdate (#270) 
updates:
- [github.com/astral-sh/uv-pre-commit: 0.11.17 → 0.11.19](https://github.com/astral-sh/uv-pre-commit/compare/0.11.17...0.11.19)
- [github.com/astral-sh/ruff-pre-commit: v0.15.15 → v0.15.16](https://github.com/astral-sh/ruff-pre-commit/compare/v0.15.15...v0.15.16)

Co-authored-by: pre-commit-ci[bot] <66853113+pre-commit-ci[bot]@users.noreply.github.com>
2026-06-08 20:08:16 +00:00
.github Bump codecov/codecov-action from 6 to 7 (#266) 2026-06-08 12:43:36 +00:00
conda-forge/recipes/template fix recipe 2024-08-23 10:14:21 +02:00
doc better documentation generation path 2026-02-03 11:00:38 +01:00
src/template Support namespace package in sys_info (#222) 2026-01-26 11:59:12 +01:00
tests Update packaging to src layout (#217) 2026-01-02 16:55:54 +01:00
tutorials fix tutorial 2024-04-03 13:52:10 +02:00
.codecov.yaml fix codecov configuration 2024-04-22 13:55:12 +02:00
.codespellignore add ignorewords file for codespell action 2022-08-07 12:13:45 +02:00
.gitignore ignore version file 2025-01-15 14:15:46 +01:00
.pre-commit-config.yaml [pre-commit.ci] pre-commit autoupdate (#270) 2026-06-08 20:08:16 +00:00
.yamllint.yaml ignore conda-forge recipe in yamllint 2023-10-25 18:02:42 +02:00
LICENSE update license 2022-05-26 20:17:42 +02:00
pyproject.toml Bump ruff from 0.15.15 to 0.15.16 (#267) 2026-06-08 12:45:24 +00:00
README.md Update packaging to src layout (#217) 2026-01-02 16:55:54 +01:00
uv.lock Bump intersphinx-registry from 0.2605.28 to 0.2606.8 (#268) 2026-06-08 12:50:46 +00:00

README.md

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 src/template to the package name and update imports
  • 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
  • Remove the conda-forge recipe from the ignored files in .yamllint.yaml
  • Edit the triggers in the release workflow, setup PyPI trusted publishing, and remove the publishing URL to test PyPI

The environment can then be setup with uv sync (assuming the current working directory is the root of the repository).

To retain the auto-upgrade of the uv.lock file, the 2 following secrets must be added:

  • UV_LOCK_UPGRADER_APP_ID
  • UV_LOCK_UPGRADER_APP_PRIVATE_KEY

And the associated app must be installed in the repository (or namespace).

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