From 307df1b7a892911ade0190c6ac2d971435fccf2b Mon Sep 17 00:00:00 2001 From: Manon Blanco <blanco@teklia.com> Date: Thu, 19 Oct 2023 15:03:25 +0000 Subject: [PATCH] Install using pip without cloning explicitly --- docs/get_started/index.md | 26 ++++++++++++++++++++++++-- 1 file changed, 24 insertions(+), 2 deletions(-) diff --git a/docs/get_started/index.md b/docs/get_started/index.md index 7d57d80b..ddc34d0f 100644 --- a/docs/get_started/index.md +++ b/docs/get_started/index.md @@ -1,6 +1,26 @@ # Get started -To use DAN in your own environment, you need to first clone via: +## Installation + +To use DAN in your own environment, you need to install it as a dependency or manually. + +### As a dependency + +To install DAN as a dependency, you need to first add the following line to your `requirements.txt` file: + +```shell +teklia-dan @ git+ssh://git@gitlab.teklia.com/atr/dan.git +``` + +Then you can install it via pip: + +```shell +pip install -r requirements.txt +``` + +### Manually + +To install DAN manually, you need to first clone via: ```shell git clone git@gitlab.teklia.com:atr/dan.git @@ -9,9 +29,11 @@ git clone git@gitlab.teklia.com:atr/dan.git Then you can install it via pip: ```shell -pip install -e . +pip install . ``` +--- + To learn more about the newly installed `teklia-dan` command, make sure to run: ```shell -- GitLab