-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
28 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -33,24 +33,41 @@ source <envionment_name>/bin/activate | |
|
||
## Installation | ||
|
||
To install this library, begin by cloning this repository: | ||
1. Clone the repository: | ||
|
||
``` | ||
git clone [email protected]: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: | ||
|
cac2fe7
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Coverage Report