Skip to content

Commit

Permalink
Update venv install checks. (#834)
Browse files Browse the repository at this point in the history
* Change Ubuntu tests to install from local bdist_wheel w/o using the
pip cache.

* Update docs re: upgrading pip in venvs.

Closes #833
  • Loading branch information
molpopgen authored Oct 25, 2021
1 parent 35e5d9d commit 9376c1c
Show file tree
Hide file tree
Showing 3 changed files with 20 additions and 1 deletion.
5 changes: 4 additions & 1 deletion .github/workflows/ubuntu.yml
Original file line number Diff line number Diff line change
Expand Up @@ -118,13 +118,16 @@ jobs:
python setup.py sdist
python setup.py check
python -m twine check dist/*.tar.gz
rm -rf dist/*.tar.gz
- name: Test pip install from dist in fresh venv
run: |
python -m venv venv
source venv/bin/activate
pip install --upgrade setuptools pip wheel
python -m pip install dist/*.tar.gz
python setup.py bdist_wheel
python -m pip install --no-cache-dir dist/fwdpy11*-linux*.whl
python -m fwdpy11 --includes
python -c "import fwdpy11;print(fwdpy11.__version__)"
python -c "import fwdpy11;print(fwdpy11.__file__)"
8 changes: 8 additions & 0 deletions doc/misc/changelog.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,14 @@
Major changes are listed below. Each release likely contains fiddling with back-end code,
updates to latest `fwdpp` version, etc.

## 0.16.2

Documentation

* Document that virtual envs should upgrade `pip`.
`pr`{834}
`issue`{833}

## 0.16.1

New features:
Expand Down
8 changes: 8 additions & 0 deletions doc/pages/userenv.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,17 @@ The recommended procedure is to install into a virtual environment:
mkdir ~/venvs
python3 -m venv ~/venvs/fwdpy11
source activate ~/venvs/fwdpy11/bin/activate
python -m pip install --upgrade pip
pip install fwpdy11
```

:::{note}

The reason to upgrade `pip` is so that dependencies are properly-handled.
This step will not be required for all users, but we recommend it just in case

:::

If you must install from source, see the {ref}`developer's guide <developersguide>`.

## Conda
Expand Down

0 comments on commit 9376c1c

Please sign in to comment.