From 9376c1c1807bc8ce84db436a9ab7dfc3adac9d2b Mon Sep 17 00:00:00 2001 From: "Kevin R. Thornton" Date: Mon, 25 Oct 2021 12:30:26 -0700 Subject: [PATCH] Update venv install checks. (#834) * Change Ubuntu tests to install from local bdist_wheel w/o using the pip cache. * Update docs re: upgrading pip in venvs. Closes #833 --- .github/workflows/ubuntu.yml | 5 ++++- doc/misc/changelog.md | 8 ++++++++ doc/pages/userenv.md | 8 ++++++++ 3 files changed, 20 insertions(+), 1 deletion(-) diff --git a/.github/workflows/ubuntu.yml b/.github/workflows/ubuntu.yml index cffd783e5..ab62a72a1 100644 --- a/.github/workflows/ubuntu.yml +++ b/.github/workflows/ubuntu.yml @@ -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__)" diff --git a/doc/misc/changelog.md b/doc/misc/changelog.md index afd67ed74..eabddcc83 100644 --- a/doc/misc/changelog.md +++ b/doc/misc/changelog.md @@ -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: diff --git a/doc/pages/userenv.md b/doc/pages/userenv.md index f818c51cc..5b6ef3d99 100644 --- a/doc/pages/userenv.md +++ b/doc/pages/userenv.md @@ -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 `. ## Conda