From a4dfffb40dd285c103efbaf8d927a6b70d9245c7 Mon Sep 17 00:00:00 2001 From: Histausse Date: Mon, 15 May 2023 22:00:30 +0200 Subject: [PATCH] reference to poetry in readme --- TODO.md | 1 - {{ cookiecutter.project_slug }}/.gitignore | 1 + {{ cookiecutter.project_slug }}/README.md | 7 ++++--- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/TODO.md b/TODO.md index f741092..33f655a 100644 --- a/TODO.md +++ b/TODO.md @@ -1,6 +1,5 @@ # TODO: -- edit readme to use poetry - tests - add AGPL - add CI diff --git a/{{ cookiecutter.project_slug }}/.gitignore b/{{ cookiecutter.project_slug }}/.gitignore index a23a015..f9373f0 100644 --- a/{{ cookiecutter.project_slug }}/.gitignore +++ b/{{ cookiecutter.project_slug }}/.gitignore @@ -26,6 +26,7 @@ wheels/ *.egg # virtualenv +.venv/ venv/ # mypy diff --git a/{{ cookiecutter.project_slug }}/README.md b/{{ cookiecutter.project_slug }}/README.md index 99ed047..23d57dd 100644 --- a/{{ cookiecutter.project_slug }}/README.md +++ b/{{ cookiecutter.project_slug }}/README.md @@ -18,13 +18,14 @@ This project if a free software released under the {{ cookiecutter.open_source_l ## Dev -If you want to tinker with this project, you can clone it and install it in editable mode: +This project is managed by [poetry](https://python-poetry.org/). +To open a shell in a venv of the project: ``` git clone {{ cookiecutter.project_url }}.git cd {{ cookiecutter.project_slug }} -python -m venv venv && source venv/bin/activate -pip install -e .[dev] +poetry shell +poetry install ``` ### Test