From 97b02501857b7d0d6e79b1e466bba0fb516ca351 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Rafa=C5=82=20Nowak?= Date: Tue, 14 Nov 2023 22:34:52 +0100 Subject: [PATCH] conda section --- .../{{ cookiecutter.repo_name }}/README.md | 21 +++++++++++++++++-- 1 file changed, 19 insertions(+), 2 deletions(-) diff --git a/mini-poetry/{{ cookiecutter.repo_name }}/README.md b/mini-poetry/{{ cookiecutter.repo_name }}/README.md index f18a9a1..0a5213f 100644 --- a/mini-poetry/{{ cookiecutter.repo_name }}/README.md +++ b/mini-poetry/{{ cookiecutter.repo_name }}/README.md @@ -15,9 +15,26 @@ In order to get the best out of the template: * Don't commit data to your repository * Don't commit any credentials or your local configuration to your repository. Keep all your credentials and local configuration in `conf/local/` -## How to install dependencies +## Conda environment +In order to create a conda environment based on the `conda.yml` file, run: +```bash +conda env create -f conda.yml +``` +Remember to activate the conda environment in which you installed your project package before running any commands. + +## How to install project package + +You can install your project package locally with: +```bash +poetry install +``` +If you want to install your project package in editable mode, use: +```bash +poetry install --editable . +``` + +Remember that poetry will create a virtual environment for your project package, unless you are in a virtual environment already (see section about conda environment). -`poetry install` ## How to run your Kedro pipeline