A python cookiecutter application to create a new python project that uses poetry to manage its dependencies.
Project description
This is a cookiecutter repository to generate the file structure for a Python project that uses Poetry for its dependency management.
Github repository |
|
Documentation |
|
Example Repository |
|
Pypi |
Features
Feature |
Description |
---|---|
Poetry |
Generates a poetry environment file, ready to be installed with a single command. |
Makefile |
A makefile with pre-configured commands, type make help to list the options. |
Pytest |
Adds a pytest template. |
Formatting |
|
CI/CD with Github actions |
Adds Github actions that run the formatting checks and unittests for pull requests and when merged to main. |
Release to Pypi |
Release to Pypi by creating a new release on Github. |
Release to Artifactory |
Release to Artifactory by creating a new release on Github. |
Documentation with Sphinx |
Automatically add documentation to your project and its code with Sphinx. |
Tox testing |
Setup and CI/CD integration to easily test for different Python versions with Tox. |
Quickstart
On your local machine, navigate to the directory in which you want to create a project directory, and run the following two commands:
pip install cookiecutter-poetry
ccp
Alternatively, install cookiecutter and directly pass the URL to this Github repository to the cookiecutter command:
pip install cookiecutter
cookiecutter https://github.com/fpgmaas/cookiecutter-poetry.git
Then run the following commands, replacing <project-name>, with the name that you also gave the Github repository and <github_author_handle> with your Github username.
cd <project_name>
git init -b main
git add .
git commit -m "Init commit"
git remote add origin git@github.com:<github_author_handle>/<project_name>.git
git push -u origin main
Finally, install the environment with make install.
If you want to deploy to Pypi or Artifactory automatically on each release, you need to set some secrets in your repository on Github. For more information, see the documentation
Acknowledgements
This project is partially based on Audrey Feldroy’s’s great cookiecutter-pypackage repository.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cookiecutter-poetry-0.0.5.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9ffbce8ce55d9b4d8b8d901379db77831e274351479287d634d665a600833c02 |
|
MD5 | 7d7677244e0a5c674ab869c9dabc78af |
|
BLAKE2b-256 | 0246200638437aca82c0b56cde9a317c164b5f9a01cae52822d84aaf84eb2a83 |
Hashes for cookiecutter_poetry-0.0.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 57a0a35f8a1b6604e34ddd93960e6adc446a46d5cb2e89902d3edba95ebf91dc |
|
MD5 | 81ed458af8e994223401c500c955f8c9 |
|
BLAKE2b-256 | d71dc1b813eb258ba5f076910e9116d7fd657e718546a3c6683604c4c90a071c |