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

Package with hatch #856

Merged
merged 13 commits into from
Jun 11, 2024
Merged

Package with hatch #856

merged 13 commits into from
Jun 11, 2024

Conversation

eevelweezel
Copy link
Collaborator

What do these changes do?

This updates pyproject.toml to support new-style packaging with hatch, instead of setuptools / setup.py.

The existing requirements files have been combined into "dependencies" (always installed), "dev" (anything dev, lint, or testing), and "doc" (needed to build the docs). With the optional dependencies, I was trying to follow convention I've seen elsewhere. Feedback would be welcome.

Are there changes in behavior for the user?

Instead of using pip install -r requirements/..., the package can now be installed with pip install -e .[dev,doc] (where "dev" and "doc" are optional dependency groups).

Related issue number

848

Checklist

  • [ x] I think the code is well written
  • [ x] Unit tests for the changes exist
  • [ x] Documentation reflects the changes
  • [ x] If you provide code modification, please add yourself to CONTRIBUTORS.txt
    • The format is <Name> <Surname>.
    • Please keep alphabetical order, the file is sorted by names.
  • [ x] Add a new news fragment into the changes folder
    • name it <issue_id>.<type> for example (588.bug)
    • if you don't have an issue_id change it to the pr id after creating the pr
    • ensure type is one of the following:
      • .feature: Signifying a new feature.
      • .bugfix: Signifying a bug fix.
      • .doc: Signifying a documentation improvement.
      • .removal: Signifying a deprecation or removal of public API.
      • .misc: A ticket has been closed, but it is not of interest to users.
    • Make sure to use full sentences with correct case and punctuation, for example: "Fix issue with non-ascii contents in doctest text files."

@eevelweezel eevelweezel marked this pull request as draft May 23, 2024 01:56
@eevelweezel eevelweezel self-assigned this May 23, 2024
Copy link

codecov bot commented May 28, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 81.34%. Comparing base (167301f) to head (16c4ff1).

Current head 16c4ff1 differs from pull request most recent head f5763c0

Please upload reports for the commit f5763c0 to get more accurate results.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #856      +/-   ##
==========================================
- Coverage   81.36%   81.34%   -0.03%     
==========================================
  Files          24       24              
  Lines        1374     1372       -2     
  Branches      245      245              
==========================================
- Hits         1118     1116       -2     
  Misses        170      170              
  Partials       86       86              

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

@eevelweezel
Copy link
Collaborator Author

eevelweezel commented May 28, 2024

Pre-commit only supports Python 3.9+ as of v3.6.0, so I changed the requirement to pre-commit>=3.5.0 in order to support Python 3.8.

@eevelweezel eevelweezel marked this pull request as ready for review May 28, 2024 02:08
pyproject.toml Outdated Show resolved Hide resolved
Copy link
Member

@achimnol achimnol left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Could we also adopt setuptools_scm to automate the version mangling based on the latest git tags?

@eevelweezel
Copy link
Collaborator Author

eevelweezel commented Jun 4, 2024

Could we also adopt setuptools_scm to automate the version mangling based on the latest git tags?

Since we're using hatchling, I used hatch-vcs, which delivers the same functionality. I've also rebased against master.

@eevelweezel eevelweezel requested a review from achimnol June 4, 2024 01:33
@achimnol achimnol enabled auto-merge (squash) June 11, 2024 08:11
@achimnol achimnol merged commit 8e50208 into aio-libs:master Jun 11, 2024
9 checks passed
@achimnol achimnol mentioned this pull request Jun 22, 2024
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