python/{{ cookiecutter.project_slug }}/README.md

{% 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 == "True" %}[](https://ci.pains-perdus.fr/{{ repo }}){% endif %}

{{ cookiecutter.project_short_description }}

Install

With pip

This project can be installed using pip:

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

With Nix

There is a flake.nix, so you can clone the repo and use nix shell if you want.

Docker/Podman

{% if cookiecutter.configure_ci == "True" %} You can run this projet with docker or podman:

podman run --rm -it {{ cookiecutter.gitea_url.removeprefix('https://') }}/{{ cookiecutter.git_user }}/{{ cookiecutter.project_slug }}:latest {{ cookiecutter.project_slug }}

{% else %} You can build a container image using nix. To build the image, in the repo, run:

nix build -o {{ cookiecutter.project_slug }}.img .#docker

You can then load the image with:

podman load < {{ cookiecutter.project_slug }}.img

{% endif %}

Notice the image is build with nix and is very minimalist.

{% 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 }}.