Merge remote-tracking branch 'github/skeleton'

coretl · coretl · commit 9793f1c63695 · 2022-02-08T17:06:15.000Z
diff --git a/.github/pages/index.html b/.github/pages/index.html
@@ -1,9 +1,11 @@
 <!DOCTYPE html>
 <html>
-  <head>
-    <title>Redirecting to master branch</title>
-    <meta charset="utf-8">
-    <meta http-equiv="refresh" content="0; url=./master/index.html">
-    <link rel="canonical" href="master/index.html">
-  </head>
-</html>
+
+<head>
+  <title>Redirecting to master branch</title>
+  <meta charset="utf-8">
+  <meta http-equiv="refresh" content="0; url=./master/index.html">
+  <link rel="canonical" href="master/index.html">
+</head>
+
+</html>
diff --git a/.github/workflows/code.yml b/.github/workflows/code.yml
@@ -13,7 +13,7 @@ on:
   pull_request:
   schedule:
     # Run every Monday at 8am to check latest versions of dependencies
-    - cron: '0 8 * * MON'
+    - cron: "0 8 * * MON"
 
 jobs:
   lint:
@@ -40,21 +40,22 @@ jobs:
           umask 0002
           SOURCE_DATE_EPOCH=$(git log -1 --pretty=%ct) pipx run build --sdist --wheel
 
-      - name: Test cli works from the installed wheel
-        # Can remove the repository reference after https://github.com/pypa/pipx/pull/733
-        run: pipx run --spec dist/*.whl ${GITHUB_REPOSITORY##*/} --version
-
       - name: Upload Wheel and Sdist as artifacts
         uses: actions/upload-artifact@v2
         with:
           name: dist
           path: dist/*
 
+      - name: Install wheel in a venv and check cli works
+        # ${GITHUB_REPOSITORY##*/} is the repo name without org
+        # Replace this with the cli command if different to the repo name
+        run: pipx run --spec dist/*.whl ${GITHUB_REPOSITORY##*/} --version
+
   test:
     strategy:
       fail-fast: false
       matrix:
-        os: ["ubuntu-latest"]  # can add windows-latest, macos-latest
+        os: ["ubuntu-latest"] # can add windows-latest, macos-latest
         python: ["3.7", "3.8", "3.9"]
         pipenv: ["skip-lock"]
 
@@ -103,7 +104,7 @@ jobs:
       - name: Github Release
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5  # v0.1.14
+        uses: softprops/action-gh-release@1e07f4398721186383de40550babbdf2b84acfc5 # v0.1.14
         with:
           files: dist/*
           generate_release_notes: true
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
@@ -39,7 +39,7 @@ jobs:
         if: github.event_name == 'push'
         # We pin to the SHA, not the tag, for security reasons.
         # https://docs.github.com/en/actions/learn-github-actions/security-hardening-for-github-actions#using-third-party-actions
-        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305  # v3.8.0
+        uses: peaceiris/actions-gh-pages@068dc23d9710f1ba62e86896f84735d869951305 # v3.8.0
         with:
           github_token: ${{ secrets.GITHUB_TOKEN }}
           publish_dir: .github/pages
diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
@@ -21,7 +21,6 @@ repos:
         language: system
         entry: pipenv run flake8
         types: [python]
-        exclude: setup.py
 
       - id: mypy
         name: Run mypy
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -10,7 +10,9 @@
             "request": "launch",
             "justMyCode": false,
             "program": "${file}",
-            "purpose": ["debug-test"],
+            "purpose": [
+                "debug-test"
+            ],
             "console": "integratedTerminal",
             "env": {
                 // The default config in setup.cfg's "[tool:pytest]" adds coverage.
diff --git a/.vscode/settings.json b/.vscode/settings.json
@@ -1,5 +1,4 @@
 {
-    "editor.defaultFormatter": "ms-python.python",
     "python.linting.pylintEnabled": false,
     "python.linting.flake8Enabled": true,
     "python.linting.mypyEnabled": true,
diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst
@@ -50,6 +50,26 @@ commit`` on just the files that have changed::
 .. _mypy: https://github.com/python/mypy
 .. _pre-commit: https://pre-commit.com/
 
+Docstrings are pre-processed using the Sphinx Napoleon extension. As such,
+google-style_ is considered as standard for this repository. Please use type
+hints in the function signature for types. For example::
+
+    def func(arg1: str, arg2: int) -> bool:
+        """Summary line.
+
+        Extended description of function.
+
+        Args:
+            arg1: Description of arg1
+            arg2: Description of arg2
+
+        Returns:
+            Description of return value
+        """
+        return True
+
+.. _google-style: https://sphinxcontrib-napoleon.readthedocs.io/en/latest/index.html#google-vs-numpy
+
 Documentation
 -------------
 
diff --git a/Pipfile b/Pipfile
@@ -4,10 +4,10 @@ url = "https://pypi.org/simple"
 verify_ssl = true
 
 [dev-packages]
-dls_python3_skeleton = {editable = true, extras = ["dev"], path = "."}
+dls-python3-skeleton = {editable = true, extras = ["dev"], path = "."}
 
 [packages]
-dls_python3_skeleton = {editable = true, path = "."}
+dls-python3-skeleton = {editable = true, path = "."}
 
 [scripts]
 lint = "pre-commit run --all-files --show-diff-on-failure --color=always -v"
diff --git a/README.rst b/README.rst
@@ -9,7 +9,7 @@ which provides a means to keep tools and techniques in sync between multiple
 Python projects.
 
 ============== ==============================================================
-PyPI           ``pip install dls_python3_skeleton``
+PyPI           ``pip install dls-python3-skeleton``
 Source code    https://github.com/dls-controls/dls-python3-skeleton
 Documentation  https://dls-controls.github.io/dls-python3-skeleton
 Releases       https://github.com/dls-controls/dls-python3-skeleton/releases
@@ -50,8 +50,8 @@ and existing projects::
     :target: https://codecov.io/gh/dls-controls/dls-python3-skeleton
     :alt: Test Coverage
 
-.. |pypi_version| image:: https://img.shields.io/pypi/v/dls_python3_skeleton.svg
-    :target: https://pypi.org/project/dls_python3_skeleton
+.. |pypi_version| image:: https://img.shields.io/pypi/v/dls-python3-skeleton.svg
+    :target: https://pypi.org/project/dls-python3-skeleton
     :alt: Latest PyPI version
 
 .. |license| image:: https://img.shields.io/badge/License-Apache%202.0-blue.svg
diff --git a/docs/images/dls-logo.svg b/docs/images/dls-logo.svg
@@ -8,4 +8,4 @@
         <path id="path2859" d="m156.09 651.68-0.30524-2.1354c1.4474 0.12317 2.8387 0.4409 4.1468 0.93101l-2.4011 1.8011c-0.67345 0.5049-1.3214 0.23639-1.4405-0.5967" fill="#fddd04" />
         <path id="path2861" d="m148.46 656.04-7.3723 0.918c1.3908-2.2598 3.3397-4.1371 5.6539-5.4455l2.3151 3.0873c0.5049 0.67295 0.23639 1.3212-0.5967 1.4402" fill="#fddd04" />
     </g>
-</svg>
+</svg>
diff --git a/docs/tutorials/installation.rst b/docs/tutorials/installation.rst
@@ -35,7 +35,7 @@ Installing the library
 
 You can now use ``pip`` to install the library::
 
-    python3 -m pip install dls_python3_skeleton
+    python3 -m pip install dls-python3-skeleton
 
 If you require a feature that is not currently released you can also install
 from github::
diff --git a/setup.cfg b/setup.cfg
@@ -1,5 +1,5 @@
 [metadata]
-name = dls_python3_skeleton
+name = dls-python3-skeleton
 description = One line description of your module
 url = https://github.com/dls-controls/dls-python3-skeleton
 author = Firstname Lastname
@@ -55,7 +55,6 @@ ignore_missing_imports = True
 [isort]
 profile=black
 float_to_top=true
-skip=setup.py,conf.py,build
 
 [flake8]
 # Make flake8 respect black's line length (default 88),

Original file line number	Diff line number	Diff line change
`@@ -1,5 +1,4 @@`
`1`	`1`	`{`
`2`		`- "editor.defaultFormatter": "ms-python.python",`
`3`	`2`	`"python.linting.pylintEnabled": false,`
`4`	`3`	`"python.linting.flake8Enabled": true,`
`5`	`4`	`"python.linting.mypyEnabled": true,`