https://github.com/maurosilber/python-lib-template

https://github.com/maurosilber/python-lib-template

Last synced: about 2 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/maurosilber/python-lib-template
• Owner: maurosilber
• Created: 2024-10-29T21:42:06.000Z (2 months ago)
• Default Branch: main
• Last Pushed: 2024-11-08T19:52:13.000Z (about 2 months ago)
• Last Synced: 2024-11-08T20:34:03.376Z (about 2 months ago)
• Language: Jinja
• Size: 7.81 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• 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 https://github.com/maurosilber/python-lib-template 

```

## What's inside?

- A `src` layout package with a `pyproject.toml` using `hatchling` as a build backend.

  The version is dynamically obtained from the git tag with `hatch-vcs`.

- A `pixi.toml` to manage tasks and dependencies with environments for linting, testing and building the package.

- Lint with `pre-commit` using:

  - `ruff` to check and format 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.