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

Bring CI up to date #80

Open
rr- opened this issue Jul 1, 2023 · 1 comment
Open

Bring CI up to date #80

rr- opened this issue Jul 1, 2023 · 1 comment

Comments

@rr-
Copy link
Owner

rr- commented Jul 1, 2023

The linter job fails with:

- [extras.pipfile_deprecated_finder.2] 'pip-shims<=0.3.4' does not match '^[a-zA-Z-_.0-9]+$'

I believe it can be resolved by updating the dependencies in .pre-commit.

Also, we should drop unsupported Python versions, and add support for Python 3.11 to the CI matrix. The changes should be reflected in Python version pins inside pyproject.toml as well.

@LecrisUT
Copy link

Hi really like the idea of this project, great work on parsing the sphinx style documentations, that's exactly what I was looking for.

Quick unrelated comment, could the RST format be aliased as Sphinx as well?


Would you like some help bringing the CI and tools up to date? Let me know what you think about:

  • Fix the CI actions
  • Migrate the documentations to RTD
  • Add release workflow (optional: having dynamic versioning?)
  • Switch backend to hatchling or setuptools (so that it's PEP517 compatible and more in-line with PEP621)
  • Switch linters to ruff
  • Add mypy pre-commit. Technically having it in pre-commit can be a bit flaky, but if you don't care about doing the checks for different python versions and dependency versions, it should be safe

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

No branches or pull requests

2 participants