Skip to content

Commit

Permalink
Add the dependency management documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
node13h committed Jul 25, 2019
1 parent c263923 commit b3e6adb
Showing 1 changed file with 28 additions and 1 deletion.
29 changes: 28 additions & 1 deletion README.md
Expand Up @@ -44,7 +44,7 @@ lase --remote origin finish
Prerequisites:

- Python 3
- pipenv
- [pipenv](https://docs.pipenv.org/en/latest/#install-pipenv-today)

Initialize a virtualenv with dev dependencies installed:

Expand All @@ -53,6 +53,33 @@ make develop
```


### Project dependencies

Project dependencies shoud always be specified in `setup.py` using the
[compatible release](https://www.python.org/dev/peps/pep-0440/#compatible-release)
notation.


### Updating dependencies in virtualenv

Run the following after updating `setup.py`

```sh
make update-deps
```


### Installing development dependencies

Replace `<PACKAGE>` with the actual name, and `<VERSION>` with the MAJOR.MINOR
(or MAJOR.MINOR.PATCH for versions below 1.0.0) version of the package.
[Read more on compatible releases](https://www.python.org/dev/peps/pep-0440/#compatible-release).

```sh
pipenv install --dev <PACKAGE>~=<VERSION>
```


### Running unit-tests

```sh
Expand Down

0 comments on commit b3e6adb

Please sign in to comment.