Skip to content

Commit

Permalink
docs: add installation and development environment documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
mehalter committed Oct 25, 2024
1 parent abe10cc commit d0f6b90
Showing 1 changed file with 25 additions and 0 deletions.
25 changes: 25 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,28 @@ on and interacting with the CAPE infrastructure. It basically provides an
abstraction layer over the core concepts such as ETL (extract, transform, load)
jobs and analysis pipelines that allow interacting with these types of
structures without worrying about the implementation details of each.

## Installation

```sh
pip install git+https://github.com/cape-ph/capepy.git
```

## Development

Install dependencies with

```sh
poetry install
```

We have Poetry set up to install into a virtual environment within the
repository as `.venv`. You can either use the Poetry shell feature or activate
this environment directly.

```sh
# Activate the Poetry shell
poetry shell
# Activate the virtual environment directly
source .venv/bin/activate
```

0 comments on commit d0f6b90

Please sign in to comment.