From cac2fe7f6c500de94f7da144b116280f81b3e0e9 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Jo=C3=A3o=20Morado?= Date: Mon, 4 Sep 2023 12:09:26 +0100 Subject: [PATCH] README update --- README.md | 31 ++++++++++++++++++++++++++++--- 1 file changed, 28 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index edf9f3a..e9725a4 100644 --- a/README.md +++ b/README.md @@ -33,24 +33,41 @@ source /bin/activate ## Installation -To install this library, begin by cloning this repository: +1. Clone the repository: ``` git clone git@github.com:NOC-OI/dpyepline.git ``` -After cloning the repository, navigate to the root directory of the package and execute the following command (dpypeline will be installed in editable mode): +2. Navigate to the package directory: + +After cloning the repository, navigate to the root directory of the package. + +3. Install in editable mode: + +To install `dpypeline` in editable mode, execute the following comman from the root directory: ``` pip install -e . ``` -Otherwise, install the package by running: +This command will install the library in editable mode, allowing you to make changes to the code if needed. + +4. Alternative installation methods: + +- Install from the GitHub repository directly: + ``` pip install git+https://github.com/NOC-OI/dpypeline.git@main#egg=dpypeline ``` +- Install from the PyPI repository: + +``` +pip install dpypeline +``` + ## Unit tests Run tests using `pytest` in the main directory: @@ -61,6 +78,14 @@ pytest ``` ## Examples +### Python scripts + +Examples of Python scripts explaining how to use this package can be found in the examples directory. + +### Command line interface (CLI) + +TODO + ### Environment variables There are a few environment variables that need to be set so that the application can run correctly: