Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update package author and add install tests #14

Merged
merged 8 commits into from
Sep 29, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
29 changes: 29 additions & 0 deletions .github/workflows/package-build.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand All @@ -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:
Expand All @@ -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
6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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|

Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ mypy_path = "./src/"

[tool.poetry]
authors = [
"Tektronix <https://pypi.org/user/Tektronix/>",
"Tektronix <[email protected]>",
"Nicholas Felt <[email protected]>"
]
classifiers = [
Expand All @@ -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"
Expand Down
Loading