https://github.com/maurosilber/python-lib-template
https://github.com/maurosilber/python-lib-template
Last synced: 4 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/maurosilber/python-lib-template
- Owner: maurosilber
- Created: 2024-10-29T21:42:06.000Z (8 months ago)
- Default Branch: main
- Last Pushed: 2025-02-28T21:51:21.000Z (4 months ago)
- Last Synced: 2025-03-01T00:04:58.352Z (4 months ago)
- Language: Jinja
- Size: 51.8 KB
- Stars: 0
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Python template for libraries
Run the following to copy the template to ``:
```sh
pixi exec copier copy --trust --no-cleanup https://github.com/maurosilber/python-lib-template
```
## What's inside?
- A `src` layout package with a `pyproject.toml` using `hatchling` as a build backend.
- A `tool.pixi` section with environments for linting, testing and building the package.
- Lint with `pre-commit` using:
- `ruff` to check and format Python code,
- `pyright` to type-check Python code,
- `taplo` to format TOML files,
- `mdformat` to format markdown files.
- A GitHub Action, `.github/workflows/ci.yml`, to test and publish the package.
It is:
- tested for different Python versions,
- published to PyPI when the commit is tagged.
The `--trust` flag is needed to run the tasks defined in the `_tasks` key of `copier.yml`,
which creates a git repository with an initial commit
and installs the pre-commit hooks.
The `--no-cleanup` flag does not delete the repository if there are failures,
which can be needed if the pre-commit checks fail.