replace "pipenv" and "master"

Author: gilesknap

.github/workflows/code.yml

@@ -113,10 +113,6 @@ jobs:
       - name: Run tests
         run: pytest tests
 
-      - name: Create requirements_dev.txt
-        run: |
-          pip freeze --exclude-editable > requirements_dev.txt
-
       - name: Upload coverage to Codecov
         uses: codecov/codecov-action@v2
         with:

.vscode/tasks.json

@@ -6,7 +6,7 @@
         {
             "type": "shell",
             "label": "Tests with coverage",
-            "command": "pipenv run tests",
+            "command": "tox -e tests",
             "options": {
                 "cwd": "${workspaceRoot}"
             },

CONTRIBUTING.rst

@@ -39,7 +39,7 @@ on your workstation as follows::
     $ git clone git://github.com/epics-containers/python3-pip-skeleton.git
     $ cd python3-pip-skeleton
     $ virtualenv .venv
-    $ source .venv/bin/activate
+    $ s
     $ pip install -e .[dev]
     $ tox -p 
 

README.rst

@@ -17,11 +17,13 @@ Releases       https://github.com/epics-containers/python3-pip-skeleton/releases
 
 It integrates the following tools:
 
-- Pipenv for version management
-- Pre-commit with black, flake8, isort and mypy for static analysis
-- Pytest for code and coverage
+- pip and setuptools_scm for version management
+- Pre-commit with black, flake8 and isort for static analysis
+- Pytest for tests and code [email protected]:dls-controls/dls-python3-skeleton.gitcoverage
 - Sphinx for tutorials, how-to guides, explanations and reference documentation
 - GitHub Actions for code and docs CI and deployment to PyPI and GitHub Pages
+- tox -p: runs pre-commit, pytest, mypy and make docs
+  - which verifies all the things that CI does
 - If you use VSCode, it will run black, flake8, isort and mypy on save
 
 The ``skeleton`` branch of this module contains the source code that can be

docs/explanations/why-pre-commit.rst

@@ -28,7 +28,7 @@ under pytest that had a plugin, and isort under flake8:
       }
     }
 
-This had the advantage that a ``pipenv run tests`` run in CI would catch and
+This had the advantage that a ``pytest tests`` run in CI would catch and
 report all test failures, but made each run take longer than it needed to. Also,
 flake8 states that it `does not have a public, stable, Python API
 <https://flake8.pycqa.org/en/latest/user/python-api.html>`_ so did not
@@ -56,7 +56,7 @@ for those using other editors and for CI another solution was needed. Enter
 commit`` time on just the files that have changed, as well as on all tracked
 files by CI. All that is needed is a one time install of the git commit hook::
 
-  $ pipenv run pre-commit install
+  $ pre-commit install
 
 The graph now looks like:
 

docs/explanations/why-src.rst

@@ -19,10 +19,10 @@ This is tested in CI in the following way:
 - ``wheel`` job creates a wheel, then installs it in an isolated environment and
   runs the cli. This checks ``install_requirements`` are sufficient to run the
   cli.
-- ``test`` job with ``pipenv: deploy`` does an `editable install`_ of the
+- ``test`` job with ``lock: true`` does an `editable install`_ of the
   package. This is the mode that is used at development time, as modifications
   to sources can be tested without reinstalling.
-- ``test`` job with ``pipenv: skip-lock`` does a regular install, which
+- ``test`` job with ``lock: false`` does a regular install, which
   checks that all files needed for the tests are packaged with the distribution.
 
 .. _editable install: https://pip.pypa.io/en/stable/cli/pip_install/#editable-installs

docs/how-to/existing.rst

@@ -16,11 +16,6 @@ This will:
 - Push that merge branch back to the existing repo
 - Merge with the currently checked out branch, leaving you to fix the conflicts
 
-.. note::
-
-    If you installed the commandline tool in a virtualenv, be sure to run
-    ``deactivate`` when you have finished running it, otherwise ``pipenv
-    install`` will use your virtualenv rather than making its own
 
 Example merge
 -------------
@@ -84,18 +79,15 @@ First of the boilerplate files were removed::
     rm 'docs/images/dls-logo.svg'
     rm 'src/scanspec/hello.py'
 
-Then the merge conflicts were fixed, and the pipenv dependencies updated::
+Then the merge conflicts were fixed, and the dependencies updated::
 
-    $ pipenv --rm
-    $ rm Pipfile.lock
-    $ pipenv install --dev
+    $ pip install -e .[dev]
 
 The tests and docs were then run and checked::
 
-    $ pipenv run tests
-    $ pipenv run docs
+    $ tox -p
 
-Finally the results were committed, pushed, merged to master::
+Finally the results were committed, pushed, merged to main::
 
     $ git commit
     $ git push github adopt-skeleton

docs/tutorials/installation.rst

@@ -3,10 +3,6 @@ Installation
 
 .. note::
 
-    For installation inside DLS, please see the internal documentation on
-    ``dls-python3`` and ``pipenv``. Although these instructions will work
-    inside DLS, they are intended for external use.
-
     If you want to contribute to the library itself, please follow
     the `../reference/contributing` instructions.
 

docs/tutorials/new.rst

@@ -13,36 +13,34 @@ This will:
 - Create a new repo at the requested path, forked from the skeleton repo
 - Create a single commit that modifies the skeleton with the repo and package name
 
-.. note::
-
-    If you installed the commandline tool in a virtualenv, be sure to run
-    ``deactivate`` when you have finished running it, otherwise ``pipenv
-    install`` will use your virtualenv rather than making its own
 
 Getting started with your new repo
 ----------------------------------
 
-Your new repo has a workflow based on pipenv. The first thing to do is to use
-pipenv to install packages in a virtual environment::
+Your new repo has a workflow based on pip. The first thing to do is to use
+pip to install packages in a virtual environment::
 
-    pipenv install --dev
+    virtual .venv
+    source .venv/bin/activate
+    pip install -e .[dev]
 
-You can then use the ``pipenv run`` command to run shell commands within this
-virtual environment. For instance::
+You can then run any entry points declared in setup.cfg e.g.::
 
-    pipenv run python
+    python3-pip-skeleton --version
 
 will run the python interpreter with access to all the packages you need to
 develop your repo.
 
 Running the tests
 -----------------
 
-There are also some extra convenience scripts that ``pipenv run`` knows about::
+There are also some extra convenience scripts provided via tox::
+
+    tox -p
 
-    pipenv run tests
+Will run in parallel all of the checks that CI performs.
 
-will run ``pytest`` to find all the unit tests and run them. The first time you
+It will run ``pytest`` to find all the unit tests and run them. The first time you
 run this, there will be some failing tests::
 
     ============================================================================ short test summary info ============================================================================
@@ -71,7 +69,7 @@ Building the docs
 
 There is also a convenience script for building the docs::
 
-    pipenv run docs
+    tox -e docs
 
 You can then view the docs output with a web browse::
 
@@ -84,7 +82,7 @@ To push the resulting repo to GitHub, first create an empty repo from the GitHub
 website, then run the following::
 
     git remote add $(cat .gitremotes)
-    git push -u github master
+    git push -u github main
 
 This will then run the continuous integration (CI) jobs, which run the tests and
 build the docs using the commands above.

src/python3_pip_skeleton/__main__.py

@@ -266,6 +266,6 @@ def main(args=None):
     args.func(args)
 
 
-# test with: pipenv run python -m python3_pip_skeleton
+# test with: python -m python3_pip_skeleton
 if __name__ == "__main__":
     main()