ggirelli / python-package-template

A Python3.8+ package template with workflows (linting and packaging), pre-commits, and issue templates.

How to use this template

1. Update pyproject.toml.
   • Replace package name and description.
   • Add dependencies with poetry add.
   • Update homepage, repository, and keywords.
   • Update classifiers.
2. Update CONTRIBUTING.md.
   • Replace package-name.
3. Update .github/workflows/pythonpackage.yml.
   • Uncomment test part and correct path, if applicable.
4. Delete this part and update README below.

python-package-name

Short description. Et amet anim aliqua culpa sint. In commodo cupidatat nostrud ea velit dolore cupidatat ipsum aliqua ipsum ipsum. Elit elit laborum ad officia non voluptate sit sint ex incididunt anim ipsum elit quis. Cillum eu deserunt laborum sunt incididunt dolore nisi et irure est.

Features

• Short features. Et amet anim aliqua culpa sint. In commodo cupidatat nostrud ea velit dolore cupidatat ipsum aliqua ipsum ipsum. Elit elit laborum ad officia non voluptate sit sint ex incididunt anim ipsum elit quis. Cillum eu deserunt laborum sunt incididunt dolore nisi et irure est.
• ...

Requirements

Et amet anim aliqua culpa sint. In commodo cupidatat nostrud ea velit dolore cupidatat ipsum aliqua ipsum ipsum. Elit elit laborum ad officia non voluptate sit sint ex incididunt anim ipsum elit quis. Cillum eu deserunt laborum sunt incididunt dolore nisi et irure est.

Install

We recommend installing package-name using pipx. Check how to install pipx here if you don't have it yet!

Once you have pipx ready on your system, install the latest stable release of radiantkit by running:

pipx install package-name

If you see the stars (✨ 🌟 ✨), then the installation went well!

Alternatively, you can use pipx (v0.15.5+) to install directly from git, with the command:

pipx install git+https://github.com/ggirelli/package-name.git --force

Usage

Et amet anim aliqua culpa sint. In commodo cupidatat nostrud ea velit dolore cupidatat ipsum aliqua ipsum ipsum. Elit elit laborum ad officia non voluptate sit sint ex incididunt anim ipsum elit quis. Cillum eu deserunt laborum sunt incididunt dolore nisi et irure est.

License

MIT License - Copyright (c) 2021 Gabriele Girelli