Add VSCode config (#49)

Packaging, CI, docs and VSCode updates from template module

- Packaging changed to add test deps as an extra to work around pip's dependency resolver in cibuildwheel
- CI adjusted to use new packaging
- Docs use the theme with the github version links in
- VSCode lifted from the DLS Py3 Template Module, with all auto-formatting parts removed due to most of the code not conforming to existing formatting (i.e. the Black formatter)

Author: AlexanderWells-diamond

.github/workflows/code.yml

@@ -23,51 +23,40 @@ jobs:
         run: flake8
 
   build:
-    name: build/${{ matrix.os }}/${{ matrix.python }}
-    runs-on: ${{ matrix.os }}
-
     strategy:
       fail-fast: false
       matrix:
         os: [ubuntu-latest, windows-latest, macos-latest]
         python: [cp27, cp37, cp38, cp39]
 
         exclude:
+          # No cothread or asyncio for windows python 2.7 so doesn't work
           - os: windows-latest
-            # No cothread or asyncio so doesn't work
             python: cp27
 
         include:
-          - os: ubuntu-latest
-            # Put coverage in the output dir mounted in docker
-            cov_file: /output/coverage.xml
-            test_requires: cothread pytest-asyncio aioca
-            # Build an sdist here so it has the right line endings
-            sdist: true
-
-          - os: windows-latest
-            cov_file: "{project}/dist/coverage.xml"
-            # cothread doesn't work on windows
-            test_requires: pytest-asyncio aioca
-
+          # Put coverage in the project directory for mac
           - os: macos-latest
             cov_file: "{project}/dist/coverage.xml"
-            test_requires: cothread pytest-asyncio aioca
-
+          # And for windows
+          - os: windows-latest
+            cov_file: "{project}/dist/coverage.xml"
+          # But put coverage in the output dir mounted in docker for linux
           - os: ubuntu-latest
-            python: cp27
-            # asyncio doesn't work on Python2.7
-            test_requires: cothread
+            cov_file: /output/coverage.xml
+          # Build an sdist on linux so it has the right line endings
+          - os: ubuntu-latest
+            sdist: true
 
-          - os: macos-latest
-            python: cp27
-            # asyncio doesn't work on Python2.7
-            test_requires: cothread
+    name: build/${{ matrix.os }}/${{ matrix.python }}
+    runs-on: ${{ matrix.os }}
 
     steps:
       - name: Checkout Source
         uses: actions/checkout@v2
         with:
+          # require history to get back to last tag for version number of branches
+          fetch-depth: 0
           submodules: true
 
       - name: Install Python
@@ -86,8 +75,8 @@ jobs:
         run: cibuildwheel --output-dir dist
         env:
           CIBW_BUILD: ${{ matrix.python }}*64
-          CIBW_TEST_REQUIRES: pytest-cov p4p ${{ matrix.test_requires }}
-          CIBW_TEST_COMMAND: pytest --cov=softioc {project}/tests --cov-report xml:${{ matrix.cov_file }}
+          CIBW_TEST_EXTRAS: dev
+          CIBW_TEST_COMMAND: pytest {project}/tests --cov-report xml:${{ matrix.cov_file }}
           # Disable auditwheel as it isn't compatible with setuptools_dso approach
           # https://github.com/mdavidsaver/setuptools_dso/issues/17
           CIBW_REPAIR_WHEEL_COMMAND: ""
@@ -101,7 +90,7 @@ jobs:
           path: dist/softioc*
 
       - name: Upload coverage to Codecov
-        uses: codecov/codecov-action@v1
+        uses: codecov/codecov-action@v2
         with:
           name: ${{ matrix.os }}/${{ matrix.python }}
           directory: dist

.github/workflows/docs.yml

@@ -30,15 +30,9 @@ jobs:
       - name: Build Docs
         run: pipenv run docs
 
-      - uses: rishabhgupta/split-by@v1
-        id: split
-        with:
-          string: ${{ github.ref }}
-          split-by: /
-
       - name: Move to versioned directory
         # e.g. master or 0.1.2
-        run: mv build/html ".github/pages/${{ steps.split.outputs._2 }}"
+        run: mv build/html ".github/pages/${GITHUB_REF##*/}"
 
       - name: Publish Docs to gh-pages
         # Only master and tags are published

.vscode/extensions.json

@@ -0,0 +1,7 @@
+{
+    "recommendations": [
+        "ms-python.vscode-pylance",
+        "ms-python.python",
+        "ryanluker.vscode-coverage-gutters"
+    ]
+}

.vscode/launch.json

@@ -0,0 +1,23 @@
+{
+    // Use IntelliSense to learn about possible attributes.
+    // Hover to view descriptions of existing attributes.
+    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+    "version": "0.2.0",
+    "configurations": [
+        {
+            "name": "Debug Unit Test",
+            "type": "python",
+            "request": "launch",
+            "justMyCode": false,
+            "program": "${file}",
+            "purpose": ["debug-test"],
+            "console": "integratedTerminal",
+            "env": {
+                // The default config in setup.cfg's "[tool:pytest]" adds coverage.
+                // Cannot have coverage and debugging at the same time.
+                // https://github.com/microsoft/vscode-python/issues/693
+                "PYTEST_ADDOPTS": "--no-cov"
+            },
+        }
+    ]
+}

.vscode/settings.json

@@ -0,0 +1,10 @@
+{
+    "editor.defaultFormatter": "ms-python.python",
+    "python.linting.pylintEnabled": false,
+    "python.linting.flake8Enabled": true,
+    "python.linting.enabled": true,
+    "python.testing.pytestArgs": [],
+    "python.testing.unittestEnabled": false,
+    "python.testing.pytestEnabled": true,
+    "python.languageServer": "Pylance",
+}

.vscode/tasks.json

@@ -0,0 +1,16 @@
+// See https://go.microsoft.com/fwlink/?LinkId=733558
+// for the documentation about the tasks.json format
+{
+    "version": "2.0.0",
+    "tasks": [
+        {
+            "type": "shell",
+            "label": "Tests with coverage",
+            "command": "pipenv run tests",
+            "options": {
+                "cwd": "${workspaceRoot}"
+            },
+            "problemMatcher": [],
+        }
+    ]
+}

Pipfile

@@ -4,22 +4,13 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-pytest-cov = "*"
-pytest-flake8 = "*"
-sphinx-rtd-theme = "*"
-setuptools-dso = "*"
-pytest-asyncio = "*"
-p4p = "*"
+softioc = {editable = true, extras = ["dev"], path = "."}
 
 [packages]
-# All other package requirements from setup.py
 softioc = {editable = true, extras = ["useful"], path = "."}
-# Apart from the epicscorelibs which comes from pyproject.toml so needs to be here too
-# epicscorelibs = "*"
 
 [scripts]
-# Put coverage here so we don't interfere with debugging in the IDE
-# Put flake8 here so we don't run it during cibuildwheel tests
-tests = "python -m pytest --cov=softioc --cov-report term --flake8"
+# Do flake8 here so it doesn't happen in the container in CI
+tests = "python -m pytest --flake8"
 docs = "sphinx-build -EWT --keep-going docs build/html"
 gitclean = "git clean -fdX"

Pipfile.lock

@@ -12,11 +12,6 @@
     padding: 4px 6px;
 }
 
-/* allow us to stop margin after list so we can add to it */
-.no-margin-after-ul ul {
-    margin-bottom: 0 !important;
-}
-
 /* Add two-column option */
 @media only screen and (min-width: 1000px) {
     .columns {