Maintenance updates 2021 08 (#7)

* added test publish on tag

* use build and publish action

* added lint and check_build

* converted README to md

* moved code to src

* added pyproject.toml

* moved settings to setup.cfg

* moved code to src

* README.rst -> README.md

* added various configs

* added docstrings

* v1.0.1

* formatted with black

Author: davidlday

.github/workflows/pypi-publish.yml

@@ -1,6 +1,3 @@
-# This workflows will upload a Python Package using Twine when a release is created
-# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
-
 name: Upload Python Package
 
 on:
@@ -10,7 +7,6 @@ on:
 jobs:
   deploy:
     runs-on: ubuntu-latest
-
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python
@@ -20,11 +16,12 @@ jobs:
       - name: Install dependencies
         run: |
           python -m pip install --upgrade pip
-          pip install setuptools wheel twine
-      - name: Build and publish
-        env:
-          TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}
-          TWINE_PASSWORD: ${{ secrets.PYPI_API_TOKEN }}
+          pip install setuptools wheel twine build
+      - name: Build Dists
         run: |
-          python setup.py sdist bdist_wheel
-          twine upload dist/*
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.PYPI_API_TOKEN }}

.github/workflows/pypi-test-publish.yml

@@ -0,0 +1,29 @@
+name: Test Upload Python Package
+
+on:
+  push:
+    tags:
+      - "v*"
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine build
+      - name: Build Dists
+        run: |
+          python -m build
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: __token__
+          password: ${{ secrets.TEST_PYPI_API_TOKEN }}
+          repository_url: https://test.pypi.org/legacy/

.github/workflows/python-ci.yml

@@ -6,12 +6,23 @@ name: Python CI
 on: [push, pull_request]
 
 jobs:
-  build:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check Out
+        uses: actions/checkout@v2
+      - name: Black
+        uses: psf/black@stable
+      - name: Pylint
+        uses: cclauss/[email protected]
+        with:
+          args: pip install .; pylint src/**/*.py
+
+  test:
     runs-on: ubuntu-latest
     strategy:
       matrix:
         python-version: [2.7, 3.6, 3.7, 3.8, 3.9]
-
     steps:
       - uses: actions/checkout@v2
       - name: Set up Python ${{ matrix.python-version }}
@@ -24,14 +35,25 @@ jobs:
       - name: Install module
         run: |
           pip install -e .
-      - name: Lint with flake8
-        run: |
-          pip install flake8
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
       - name: Test with pytest
         run: |
           pip install pytest
           pytest
+
+  check_build:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Check Out
+        uses: actions/checkout@v2
+      - name: Set up Python
+        uses: actions/setup-python@v2
+        with:
+          python-version: "3.x"
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install setuptools wheel twine build
+      - name: Build
+        run: python -m build
+      - name: Check
+        run: twine check dist/*

.markdownlint.yaml

@@ -0,0 +1,2 @@
+MD034: false # no-bare-urls: Bare URL used
+MD024: false # no-duplicate-heading/no-duplicate-header: Multiple headings with the same content

.prettierrc

@@ -0,0 +1,4 @@
+{
+  "proseWrap": "always",
+  "trailingComma": "all"
+}