Packaging: Use `versioningit` for maintaining the package version #535

amotl · 2024-10-24T05:39:09Z

About

versioningit, we love very much, and use it on many Python projects we publish to PyPI.
In order to prepare migration to pyproject.toml, phase out the Debian package builder to a dedicated utility program bin/mkdeb.py. It can be hooked into a corresponding poethepoet task afterwards, to improve invocation convenience if you need it.

Status

This patch is also stacked upon GH-532, so its merge order is currently on the last position of the synthetic merge queue.

coderabbitai · 2024-10-24T05:39:17Z

Important

Review skipped

Draft detected.

Please check the settings in the CodeRabbit UI or the .coderabbit.yaml file in this repository. To trigger a single review, invoke the @coderabbitai review command.

You can disable this status message by setting the reviews.review_status to false in the CodeRabbit configuration file.

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

❤️ Share

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

Review comments: Directly reply to a review comment made by CodeRabbit. Example:
- I pushed a fix in commit <commit_id>, please review it.
- Generate unit testing code for this file.
- Open a follow-up GitHub issue for this discussion.
Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
- @coderabbitai generate unit testing code for this file.
- @coderabbitai modularize this function.
PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
- @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
- @coderabbitai read src/utils.ts and generate unit testing code.
- @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
- @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

@coderabbitai pause to pause the reviews on a PR.
@coderabbitai resume to resume the paused reviews.
@coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
@coderabbitai full review to do a full review from scratch and review all the files again.
@coderabbitai summary to regenerate the summary of the PR.
@coderabbitai resolve resolve all the CodeRabbit review comments.
@coderabbitai configuration to show the current CodeRabbit configuration for the repository.
@coderabbitai help to get help.

Other keywords and placeholders

Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
Add @coderabbitai anywhere in the PR title to generate the title automatically.

CodeRabbit Configuration File (`.coderabbit.yaml`)

You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
Please see the configuration documentation for more information.
If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

Visit our Documentation for detailed information on how to use CodeRabbit.
Join our Discord Community to get help, request features, and share feedback.
Follow us on X/Twitter for updates and announcements.

kennethreitz · 2024-10-24T19:14:17Z

docs/source/conf.py


 project = "responder"
-copyright = "2018, A Kenneth Reitz project"
+copyright = "2018-2024, A Kenneth Reitz project"


i typically just add the current year and keep it up to date

kennethreitz · 2024-10-24T19:14:59Z

setup.py

-        os.system("dpkg-buildpackage -rfakeroot -uc -us")
-
-
-class UploadCommand(Command):


I use this on all my projects.

I hear you. However, I think package authors gradually need to modernize.

setup.py-based commands are being deprecated by setuptools and friends, at some time setup.py per se might also become deprecated, and in general, pyproject.toml-based project metadata tech is mature, even without special tooling (just setuptools), it will be the future and it is here to stay.

In this spirit, project metadata will not be able to include procedural/imperative steps natively any longer. I think it makes sense to accompany modernizations in the Python ecosystem, and will be happy to support you in getting back your loved sandbox workflows based on modern utilities, based on curated recipes we have been crafting on other projects we are maintaining.

Effectively, it will just be another incantation command to remember, for example poe upload or poe build-deb. I think it will be easy to adjust, and you may want to reuse the recipes you like also on your other projects when modernizing them.

If you agree, let's do that on behalf of this project and the next iterations. If you disagree, let's close this PR again.

i have mixed feelings, but I'm not opposed. Let's just document the procedures for making a release, etc.

thanks again for the help

kennethreitz · 2024-10-25T11:41:36Z

got some nasty merge conflicts on this one. i'm down to merge though, once resolved

kennethreitz · 2024-10-25T11:45:42Z

responder/__init__.py

 from . import ext
 from .core import API, Request, Response

+__appname__ = "responder"


I've never seen __appname__ before. What's this from?

Probably just a stray pickup. We can also remove it again.

The Debian package builder has been saved to `bin/mkdeb.py` for now. It needs to be refurbished into a `poethepoet` task subsequently.

amotl · 2024-10-25T12:24:50Z

While I've used it like this before, I currently can't get versioningit to work, with a mixture of setup.py and pyproject.toml.

ValueError: Could not parse `git describe` output

-- https://github.com/kennethreitz/responder/actions/runs/11518104403/job/32064158112?pr=535#step:5:22

Let's postpone this patch to a later iteration, after migrating to a pure pyproject.toml-based metadata setup.
So, I am sending this PR on a hiatus.

amotl force-pushed the versioningit branch 3 times, most recently from b11187e to dc13b94 Compare October 24, 2024 06:15

amotl force-pushed the tasks branch from 4c82049 to 985d72e Compare October 24, 2024 13:48

amotl force-pushed the versioningit branch 2 times, most recently from 1033e3c to f64a7ba Compare October 24, 2024 13:54

amotl force-pushed the tasks branch 3 times, most recently from 86456fc to 7df6d17 Compare October 24, 2024 16:26

kennethreitz reviewed Oct 24, 2024

View reviewed changes

Base automatically changed from tasks to main October 25, 2024 11:39

kennethreitz reviewed Oct 25, 2024

View reviewed changes

amotl force-pushed the versioningit branch 2 times, most recently from 392e30f to 84a2fdc Compare October 25, 2024 12:17

Packaging: Use versioningit for maintaining the package version

cc0fe78

The Debian package builder has been saved to `bin/mkdeb.py` for now. It needs to be refurbished into a `poethepoet` task subsequently.

amotl force-pushed the versioningit branch from 84a2fdc to cc0fe78 Compare October 25, 2024 12:21

amotl mentioned this pull request Oct 25, 2024

Maintenance 2024-10 #525

Closed

amotl added dependencies Pull requests that update a dependency file project and packaging All things project metadata and packaging labels Oct 27, 2024

		os.system("dpkg-buildpackage -rfakeroot -uc -us")


		class UploadCommand(Command):

Uh oh!

Packaging: Use versioningit for maintaining the package version #535

Are you sure you want to change the base?

Packaging: Use versioningit for maintaining the package version #535

Uh oh!

Conversation

amotl commented Oct 24, 2024

About

Status

Uh oh!

coderabbitai bot commented Oct 24, 2024

Review skipped

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

kennethreitz Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

amotl Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

kennethreitz Oct 24, 2024

Choose a reason for hiding this comment

Uh oh!

amotl Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

kennethreitz Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

kennethreitz Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

kennethreitz commented Oct 25, 2024

Uh oh!

kennethreitz Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

amotl Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

amotl Oct 25, 2024

Choose a reason for hiding this comment

Uh oh!

amotl commented Oct 25, 2024 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Packaging: Use `versioningit` for maintaining the package version #535

Packaging: Use `versioningit` for maintaining the package version #535

CodeRabbit Configuration File (`.coderabbit.yaml`)

amotl Oct 25, 2024 •

edited

Loading

amotl Oct 25, 2024 •

edited

Loading

amotl commented Oct 25, 2024 •

edited

Loading