Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update README with poetry setup and contributing guidelines #698

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 7 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,29 +53,26 @@ below.

## 🧑🏿‍💻 Developing

### Using poetry
### Using Poetry

The development environment can be set up using
[poetry](https://python-poetry.org/docs/#installation). Hence, make sure it is
installed and then run:
[Poetry](https://python-poetry.org/docs/#installation). Ensure Poetry is installed and then run:

```bash
python3 -m poetry install
poetry install
source $(poetry env info --path)/bin/activate
```

In order to install dependencies for testing (codestyle, unit tests, integration tests),
run:
To install dependencies for testing (codestyle, unit tests, integration tests), run:

```bash
python3 -m poetry install --with test
poetry install --with test
```

API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and
can be locally built by:
API documentation is built using [Sphinx](https://www.sphinx-doc.org/en/master/) and can be locally built by:

```bash
python3 -m poetry install --with docs
poetry install --with docs
cd docs
make html SPHINXOPTS="-D nbsphinx_allow_errors=True"
```
Expand Down
Loading