https://github.com/12rambau/pypackage

The skeleton of a python package
https://github.com/12rambau/pypackage

copier copier-template package python

Last synced: about 2 months ago
JSON representation

The skeleton of a python package

• Host: GitHub
• URL: https://github.com/12rambau/pypackage
• Owner: 12rambau
• License: mit
• Created: 2022-01-15T20:48:01.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2024-10-11T15:53:52.000Z (12 months ago)
• Last Synced: 2024-10-14T07:27:15.367Z (12 months ago)
• Topics: copier, copier-template, package, python
• Language: Jinja
• Homepage:
• Size: 225 KB
• Stars: 5
• Watchers: 2
• Forks: 0
• Open Issues: 7
• Metadata Files:
  • Readme: README.rst
  • License: LICENSE

Awesome Lists containing this project

README

          
Pypackage

=========

.. |release| image:: https://img.shields.io/github/v/release/12rambau/pypackage?logo=github&logoColor=white

   :alt: GitHub release (with filter)

   :target: https://github.com/12rambau/pypackage/releases

.. |workflow| image:: https://img.shields.io/github/actions/workflow/status/12rambau/pypackage/unit.yaml?logo=github&logoColor=white

   :alt: GitHub Workflow Status (with event)

   :target: https://github.com/12rambau/pypackage/actions/workflows/unit.yaml

.. |docs| image:: https://img.shields.io/readthedocs/12rambau-pypackage?logo=readthedocs&logoColor=white

   :alt: Read the Docs

   :target: https://app.readthedocs.org/projects/12rambau-pypackage/

|release| |workflow| |docs|

The skeleton of a python lib embedding what I like:

- pre-commit hooks (`prettier `__, `ruff `__, `black `__)

- `uv `__ backed nox unit tests (doc, `pytest `__, `mypy `__)

- a documentation structure based on `Sphinx `__ using the `pydata-sphinx-theme `__

- a complete github folder (README, LICENSE, etc...)

- an automated citation file

- github actions (test, coverage, mypy, lint)

- ready to publish on `pipy `__

- ready to publish on `readthedocs `__

- ready to link to `codecov `__

Usage

-----

Follow the instructions from the `online documentation `__

Demonstration

-------------

The package end result is demonstrated in the `pypackage-skeleton `__ repository.