Skip to content

Commit

Permalink
README: Drop broken pipenv instructions
Browse files Browse the repository at this point in the history
This will need update - better to keep it out of the README for now

Signed-off-by: Gunnar Andersson <[email protected]>
  • Loading branch information
gunnar-mb committed Feb 5, 2025
1 parent 16005b5 commit 26751c1
Showing 1 changed file with 0 additions and 16 deletions.
16 changes: 0 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -132,22 +132,6 @@ NEXT: Go to **Installing packages**

Go directly to Installing packages

### Setup with `pipenv`
[pipenv](https://pypi.org/project/pipenv/) is a tool that manages a virtual environment and install the package and its dependencies, making the process much simpler and predictable, since the `Pipfile` states the dependencies, while `Pipfile.lock` freezes the exact version in use.

Install this project and its dependencies in the local `.venv` folder in this project, then use it (`pipenv shell`):
```bash
export PIPENV_VENV_IN_PROJECT=1 # will create a local `.venv` in the project, otherwise uses global location
pipenv install --dev # install the development dependencies as well
```

NEXT: Go to **Installing packages**

You can then run:
```
pipenv shell # starts a shell configured to use the virtual environment
```

### Setup and run tests using tox

Tox is another way to set up the working environment. It is primarily used to test the program using multiple python versions.
Expand Down

0 comments on commit 26751c1

Please sign in to comment.