sample-project


---

Documentation: https://melonkernel.github.io/sample-project

Source Code: https://github.com/melonkernel/sample-project

PyPI: https://pypi.org/project/sample-project/

---

A SProject created with the cookicutter template

Installation

pip install sample-project

Development

• Clone this repository
• Requirements:
  • Poetry
  • Python 3.8+
• Create a virtual environment and install the dependencies

poetry install

• Activate the virtual environment

poetry shell

Testing

poetry run pytest

Documentation

The documentation is automatically generated from the content of the docs directory and from the docstrings of the public signatures of the source code. The documentation is updated and published as a Github Pages page automatically as part each release.

Releasing

Trigger the Draft release workflow (press Run workflow). This will update the changelog & version and create a GitHub release which is in Draft state.

Find the draft release from the GitHub releases and publish it. When a release is published, it'll trigger release workflow which creates PyPI release and deploys updated documentation.

Pre-commit

Pre-commit hooks run all the auto-formatting (ruff format), linters (e.g. ruff and mypy), and other quality checks to make sure the changeset is in good shape before a commit/push happens.

You can install the hooks with (runs for each commit):

poetry run pre-commit install

Or if you want them to run only for each push:

poetry run pre-commit install -t pre-push

Or if you want e.g. want to run all checks manually for all files:

poetry run pre-commit run --all-files

---

Using Poetry

To add a pythond package, for instance requests, run:

poetry add requests

To add a dev depencency, use the --dev flag:

poetry add gradio --dev

Cruft

If you created this project with Cruft and want to update to the newest settings in the original template, run:

cruft update

This project was generated using the project-templates template.

Run demo

poetry run gradio demo.py