Update package author and add install tests (#14)

* ci: Use new workflow for assigning reviewers.

* ci: Assign reviewers on all PR types

* ci: Add steps to verify package can be installed from test.pypi.org and pypi.org after uploading it.

* ci: Use new workflow for assigning reviewers.

* ci: Assign reviewers on all PR types

* docs: Update order of badges in readme.

* ci: Add test for installing wheel and tarball to the build package workflow.

* build: Update package author to allow package upload.

.github/workflows/package-build.yml

@@ -25,6 +25,20 @@ jobs:
         with:
           fetch-depth: 0
       - uses: hynek/[email protected]
+        id: build-pkg
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: x  # any version
+          check-latest: true
+      - name: Test installing wheel
+        run: |
+          pip install ${{ steps.build-pkg.outputs.dist }}/*.whl
+          pip uninstall --yes tm_devices
+      - name: Test installing tarball
+        run: |
+          pip install ${{ steps.build-pkg.outputs.dist }}/*.tar.gz
+          pip uninstall --yes tm_devices
 
   # Upload to Test PyPI on every push to main
   test-pypi:
@@ -43,6 +57,14 @@ jobs:
         uses: pypa/[email protected]
         with:
           repository-url: https://test.pypi.org/legacy/
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: x  # any version
+          check-latest: true
+      - name: Test installing from test.pypi.org
+        run: pip install --index-url=https://test.pypi.org/simple/ --extra-index-url=https://pypi.org/simple
+          tm_devices
 
   # Upload to PyPI and create a tag in the repo after a GitHub Release is published
   pypi:
@@ -66,3 +88,10 @@ jobs:
         run: |-
           git tag --annotate v${{ github.event.release.tag_name }} --message="${{ github.event.release.name }}"
           git push --tags
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: x  # any version
+          check-latest: true
+      - name: Test installing from pypi.org
+        run: pip install tm_devices

README.rst

@@ -21,7 +21,7 @@
    * - Documentation
      - |Documentation status|
    * - Code Style
-     - |Code style: black| |Test style: pytest| |Imports: isort| |Docstring style: google|
+     - |Test style: pytest| |Code style: black| |Imports: isort| |Docstring style: google|
    * - Linting
      - |pre-commit enabled| |Docstring formatter: docformatter| |Type Checker: pyright| |Linter: pylint| |Linter: Ruff|
 
@@ -237,12 +237,12 @@ Supported Connections
 Documentation
 -------------
 
-See the full documentation at https://tm_devices.readthedocs.io
+See the full documentation at `<https://tm_devices.readthedocs.io>`__
 
 Maintainers
 -----------
 
--  Tektronix https://pypi.org/user/Tektronix/
+-  Tektronix [email protected]
 -  Nicholas Felt [email protected]
 
 Contributing

pyproject.toml

@@ -43,7 +43,7 @@ mypy_path = "./src/"
 
 [tool.poetry]
 authors = [
-  "Tektronix <https://pypi.org/user/Tektronix/>",
+  "Tektronix <[email protected]>",
   "Nicholas Felt <[email protected]>"
 ]
 classifiers = [
@@ -68,7 +68,7 @@ keywords = [
 ]
 license = "Apache License 2.0"
 maintainers = [
-  "Tektronix <https://pypi.org/user/Tektronix/>",
+  "Tektronix <[email protected]>",
   "Nicholas Felt <[email protected]>"
 ]
 name = "tm_devices"