Skip to content

Commit

Permalink
README update
Browse files Browse the repository at this point in the history
  • Loading branch information
JMorado committed Sep 4, 2023
1 parent e1d240c commit cac2fe7
Showing 1 changed file with 28 additions and 3 deletions.
31 changes: 28 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand Down

1 comment on commit cac2fe7

@github-actions
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Coverage

Coverage Report
FileStmtsMissCoverMissing
/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/dpypeline/akita
   core.py1361360%2–366
   event_handler.py41410%3–215
   factory.py34340%3–174
   queue_events.py1213075%22–23, 27, 86, 91, 102, 113–117, 144–155, 184–185, 214–215, 262–271
/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/dpypeline/cli
   argument_parser.py770%2–29
   main_cli.py32320%2–71
   yaml_constructors.py66660%2–130
   yaml_executers.py15150%2–24
   yaml_loader.py18180%2–44
/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/dpypeline/etl_pipeline
   basic_pipeline.py12120%2–34
   core.py52983%103, 115–123, 172, 178
   decorators.py24240%2–61
   thread_pipeline.py330%2–8
/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/dpypeline/event_consumer
   __init__.py110%2
   consumer_parallel.py61610%2–209
   consumer_serial.py21210%2–54
   core.py43430%2–130
/opt/hostedtoolcache/Python/3.10.12/x64/lib/python3.10/site-packages/dpypeline/filesystems
   __init__.py110%2
   object_store.py90900%2–383
TOTAL82764422% 

Tests Skipped Failures Errors Time
11 0 💤 0 ❌ 0 🔥 0.980s ⏱️

Please sign in to comment.