templates/python
1
0
Fork 0
Code Issues Pull requests Projects Releases Wiki Activity
python/{{ cookiecutter.project_slug }}/README.md
Histausse 6aa251e9ec add badge
2023-05-19 18:32:16 +02:00

1.1 KiB
Raw Blame History

{% set is_open_source = cookiecutter.open_source_license != 'Proprietary' -%} {% set repo = "/".join(cookiecutter.git_origin.removesuffix(".git").split(":")[-1].split("/")[-2:]) %}

{{ cookiecutter.project_name }}

{% if cookiecutter.configure_ci %}![CI status badge]({{ cookiecutter.woodpecker_server }}/api/badges/{{ repo }}/status.svg){% endif %}

{{ cookiecutter.project_short_description }}

Install

This project can be installed using pip:

pip install git+{{ cookiecutter.project_url }}.git

{% if is_open_source %}

License

This project if a free software released under the {{ cookiecutter.open_source_license }}.

Dev

This project is managed by poetry.

To open a shell in a venv of the project:

git clone {{ cookiecutter.project_url }}.git
cd {{ cookiecutter.project_slug }}
poetry shell
poetry install

Test

Tests are run using pytest:

poetry run pytest

{% endif %}

Author

  • {{ cookiecutter.full_name }}

Security

If you discover a potential security issue in this project, please contact {{ cookiecutter.email }}.