Skip to content

Make some modernizations to the polling2 project#104

Open
ngie-eign wants to merge 9 commits intoddmee:masterfrom
ngie-eign:modernize
Open

Make some modernizations to the polling2 project#104
ngie-eign wants to merge 9 commits intoddmee:masterfrom
ngie-eign:modernize

Conversation

@ngie-eign
Copy link

@ngie-eign ngie-eign commented Mar 14, 2025

  • .github/workflows/documentation-links.yml: add readthedocs.org GitHub Actions workflow.
  • .pre-commit-config.yaml: run autoupdate to update software versions.
  • polling2.py: fix minor ruff check issues.
  • setup.py:
    • Update classifiers to include more versions of python.
    • Remove pytest-runner dependency: it's not needed for runtime and its use has been deprecated for a couple years now.
  • docs/:
    • resolve complaints from Snyk by upgrading Sphinx and removing all transitive dependencies.
    • resolve a complaint about header syntax not running the length of the previous line.
  • tests/:
    • Support unittest.mock with python3.
    • Make code ruff check clean.
  • tox.ini: Add more environments to the tox test matrix.

@ngie-eign
Copy link
Author

The readthedocs.org job needs to be updated to use the supported GitHub action workflow: https://github.com/readthedocs/actions?tab=readme-ov-file#github-actions-for-read-the-docs

@sonarqubecloud
Copy link

This updates software versions to more recently supported versions.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Make `mock` conditional on python3, both in terms of the consuming code
and the setuptools code.

While here, update the classifiers to support python2 and python3, as
well as newer versions of python3.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
This change resolves a number of issues highlighted by `ruff check`,
including issues around lines being too long, docstring complaints,
using `pytest.raises` instead of unrolled try-except blocks, etc.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
@ngie-eign
Copy link
Author

The readthedocs.org job needs to be updated to use the supported GitHub action workflow: https://github.com/readthedocs/actions?tab=readme-ov-file#github-actions-for-read-the-docs

And now that's been deprecated without a clear path forward... trying to get clarity on what the path forward might be: readthedocs/actions@d0c3898#commitcomment-169018586 .

The SonarQube complaint is because I used a release label, not a commit hash. Once I get clarity on ☝️ I'll make the change to appease SonarQube.

@ngie-eign ngie-eign force-pushed the modernize branch 3 times, most recently from dde8513 to d949272 Compare October 28, 2025 19:59
ngie-eign referenced this pull request in readthedocs/actions Oct 28, 2025
@ngie-eign
Copy link
Author

I'm dropping the workflow commit which will solve the SonarQube complaint.
According to the authors in the commit comment thread linked above, it looks like all you need to do is enroll the GH app against the repo as described here.

Technically this isn't the latest version, but given that 3.9 is EOL
already and isn't installed on my system, 3.11 is "good enough" for now.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
Extend the section header markup to the rest of the previous line.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
synk is flagging a ton of issues with indirect dependencies. Only
capture the direct dependencies to avoid getting flogged by every synk
complaint from the project.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
- 3.7 is _very_ EOL at this point. Remove that explicit dependency.
- Switch to the latest version of Ubuntu LTS.

Hopefully this will build with the readthedocs infrastructure.

Signed-off-by: Enji Cooper <yaneurabeya@gmail.com>
@sonarqubecloud
Copy link

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant