Merge skeleton (#6)

* Squash commits from dls-python3-skeleton skeleton branch

Author: gilesknap

.github/workflows/code.yml

@@ -173,7 +173,7 @@ jobs:
           path: dist
 
       - name: Cache Docker layers
-        uses: actions/cache@v2
+        uses: actions/cache@v3
         with:
           path: /tmp/.buildx-cache
           key: ${{ runner.os }}-buildx-${{ github.sha }}

CONTRIBUTING.rst

@@ -4,17 +4,25 @@ Contributing
 Contributing to the skeleton repository is different to other repos. There
 are two sorts of contributions:
 
-- Changes to the skeleton structure should be made on a branch, then a
-  PR_ raised back to the ``skeleton`` branch.
-- Changes to the docs or commandline tool should be made directly on main
-
+- Changes to the skeleton structure should be made on a branch
+  of the skeleton-repo_ with a PR
+  raised back to the ``main`` branch from here: PR_.
+- Changes to the docs or commandline tool should be made on a branch in 
+  the cli-repo_ with with a PR raised back to the ``main`` branch
+  here: PR2_
+
+.. _skeleton-repo: https://github.com/epics-containers/python3-pip-skeleton
+.. _cli-repo: https://github.com/epics-containers/python3-pip-skeleton-cli
 .. _PR:  https://github.com/epics-containers/python3-pip-skeleton/pulls
-.. _GitHub: https://github.com/epics-containers/python3-pip-skeleton/issues
+.. _PR2:  https://github.com/epics-containers/python3-pip-skeleton-cli/pulls
+
+Apart from this, ``main`` branch in both repos should always be deployable,
+and are considered the latest release.
 
 Running the tests
 -----------------
 
-Both the ``skeleton`` and ``main`` branch have different tests, but
+Both the ``skeleton`` and ``main`` repos have different tests, but
 the process to run them is the same. You can run in a container using the 
 supplied devcontainer or you can run them locally.
 
@@ -43,38 +51,6 @@ on your workstation as follows::
     $ pip install -e .[dev]
     $ tox -p 
 
-In both cases tox -p runs in parallel the following checks:
-
-  - Build Spinx Documentation
-  - run pytest on all tests in ./tests
-  - run mypy linting on all files in ./src ./tests
-  - run pre-commit checks:
-
-    - run flake8 style checks against all source
-    - run black formatting checks against all source
-
-Use vscode devcontainer as follows::
-
-    $ git clone git://github.com/epics-containers/python3-pip-skeleton.git
-    $ vscode python3-pip-skeleton
-    Click on 'Reopen in Container' when prompted
-    In a vscode Terminal:
-    $ tox -p
-
-
-To run locally
-~~~~~~~~~~~~~~
-
-Get the source source code and run the unit tests directly
-on your workstation as follows::
-
-    $ git clone git://github.com/epics-containers/python3-pip-skeleton.git
-    $ cd python3-pip-skeleton
-    $ virtualenv .venv
-    $ s
-    $ pip install -e .[dev]
-    $ tox -p 
-
 Checks
 ~~~~~~
 
@@ -88,8 +64,6 @@ In both cases tox -p runs in parallel the following checks.
     - run flake8 style checks against all source
     - run black formatting checks against all source
 
-Please note that Pipfile.lock is only committed on ``main``, not on
-``skeleton``
 
 Code Styling
 ------------
@@ -182,13 +156,5 @@ To see a graph of the python package dependency tree type::
 
     pipdeptree
 
-Apart from this, ``main`` and ``skeleton`` should always be deployable,
-and are considered the latest release.
-
-Checking Dependencies
----------------------
 
-To see a graph of the python package dependency tree type::
-
-    pipdeptree
 

README.rst

@@ -26,13 +26,16 @@ It integrates the following tools:
   - 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
-merged into new or existing projects, and pulled from to keep them up to date.
-It can also serve as a working example for those who would prefer to
-cherry-pick.
+The the related ``skeleton`` repo skeleton_ for this module contains the source 
+code that can be merged into new or existing projects, and pulled from to 
+keep them up to date. It can also serve as a working example for those who 
+would prefer to cherry-pick.
 
-The ``main`` branch contains the
-docs and a command line tool to ease the adoption of this skeleton into new::
+.. _skeleton: https://github.com/epics-containers/python3-pip-skeleton
+
+This ``cli`` repo contains the
+docs and a command line tool to ease the adoption of this skeleton into a
+new project like this::
 
     python3-pip-skeleton new /path/to/be/created
 
@@ -64,4 +67,5 @@ and existing projects::
     Anything below this line is used when viewing README.rst and will be replaced
     when included in index.rst
 
-See https://epics-containers.github.io/python3-pip-skeleton for more detailed documentation.
+See https://epics-containers.github.io/python3-pip-skeleton-cli for 
+more detailed documentation.

tests/test_dls_python3_skeleton.py

@@ -58,15 +58,17 @@ def test_new_module(tmp_path: Path):
     check_output("virtualenv", ".venv", cwd=module)
     check_output(".venv/bin/pip", "install", ".[dev]", cwd=module)
     check_output(
-        ".venv/bin/sphinx-build",
+        ".venv/bin/python",
+        "-m",
+        "sphinx",
         "-EWT",
         "--keep-going",
         "docs",
         "build/html",
         cwd=module,
     )
     with pytest.raises(ValueError) as ctx:
-        check_output(module / ".venv/bin/pytest", "tests", cwd=module)
+        check_output(".venv/bin/python", "-m", "pytest", module / "tests", cwd=module)
     out = ctx.value.args[0]
     print(out)
     assert "6 failed, 4 passed" in out