Skip to content

Commit

Permalink
Merge pull request #11 from 991jo/poetry
Browse files Browse the repository at this point in the history
Changed dependency and build management to poetry
  • Loading branch information
991jo authored Apr 6, 2022
2 parents b2aa8e3 + 7598850 commit 0c90807
Show file tree
Hide file tree
Showing 4 changed files with 956 additions and 30 deletions.
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,8 @@ second one always returns the same hash value.

# Installation

This package can be installed via PyPi/pip:
This package can be installed from PyPi via pip or whatever you prefer for
dependency management.

```
pip install network-hash-gen
Expand All @@ -50,18 +51,20 @@ This will generate documentation in a folder called `html`.

## Setup

Clone this repository, then create a venv.
Install this package and the development and documentation dependencies via
This project uses [poetry](https://python-poetry.org/).

Clone this repository, then run
```
pip install -e .[dev,docs]
poetry install
```
This will create a venv and install the dev dependencies.

## Running the tests

The tests can be run with
The tests are in the `tests` folder and are executed with

```
python3 -m unittest discover
python3 -m unittest
```

The unittests are also run via the pre-commit hooks.
Expand All @@ -70,7 +73,7 @@ To get test coverage reports [coverage](https://coverage.readthedocs.io/en/lates
is used. Run

```
coverage run -m unittest discover
coverage run -m unittest
```

to run the tests and `coverage report` for a CLI report of `coverage html` to
Expand Down
Loading

0 comments on commit 0c90807

Please sign in to comment.