Skip to content

Migrate to pyproject.toml, update min Python to 3.9, consolidate dev workflows #209

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

Open
wants to merge 11 commits into
base: main
Choose a base branch
from

Conversation

VeckoTheGecko
Copy link
Contributor

@VeckoTheGecko VeckoTheGecko commented Dec 12, 2024

Changes:

  • Migrate to pyproject.toml
  • Update min Python version to 3.9
  • Add pypi metadata classifiers
  • Add contributing guide
  • Consolidate installation (for users, testing and docs)
  • Dependabot config
  • Fix conf.py
  • Clean up tests.yml
  • Remove circleci
  • Add tests.utils to consolidate test path parameters

Can we add pre-commit CI* to this project, as well as set up docs building for PRs via RTD**?

* In preparation for when we add pre-commit config in next PR
** I think this is a better way to check that the docs build. It allows previewing the docs as well (which I don't think the circleci build did).

Copy link

codecov bot commented Dec 12, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 54.65%. Comparing base (ac3f2c5) to head (f0eed7a).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #209      +/-   ##
==========================================
- Coverage   54.90%   54.65%   -0.25%     
==========================================
  Files           9       10       +1     
  Lines        1692     1685       -7     
==========================================
- Hits          929      921       -8     
- Misses        763      764       +1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

@jklymak
Copy link
Member

jklymak commented Dec 12, 2024

So what is the plan here? Should we just merge this and see if it works, and then fix any issues?

@jklymak
Copy link
Member

jklymak commented Dec 12, 2024

Only question I had was the empty __init__.py file in tests/?

@jklymak
Copy link
Member

jklymak commented Dec 12, 2024

... also - what is the plan for changing the files to ruff? Is that a second PR? I guess I thought that would come before this PR, not after.

@VeckoTheGecko
Copy link
Contributor Author

So what is the plan here? Should we just merge this and see if it works, and then fix any issues?

Sounds good. Any particular issues that you're concerned about?

Only question I had was the empty __init__.py file in tests/?

This makes tests a package, allowing us to do from tests.utils import ... (consolidating LIBRARY_DIR to be stored in one place).

... also - what is the plan for changing the files to ruff? Is that a second PR? I guess I thought that would come before this PR, not after.

I think this PR first and then #210 would be good. Once this is merged, #210 should only be 2 commits so shouldn't be a need to rebase

@VeckoTheGecko VeckoTheGecko force-pushed the changes branch 3 times, most recently from ed9ac1f to 2114d7d Compare December 17, 2024 11:09
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.

2 participants