Maintenance 2024-10

[amotl]

Hi Kenneth. Thanks for adding me to the project. Let's use this ticket to enumerate and discuss relevant details about maintenance and friends?

[amotl]

@kennethreitz said:

• getting tests to pass is primary goal, as well as updating starlette and python compatibility.

@amotl suggests:

• Let's also rename branch master to main right away? Because I don't have ownership permissions, I would need you to conduct this operation.

[kennethreitz]

@amotl sure i'll do that now

[kennethreitz]

@coderabbitai what do you think?

[kennethreitz]

^^ an experimental bot to help with maintenance

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@kennethreitz, great job on renaming the branch to main! This aligns well with modern naming conventions. Focusing on passing tests and updating Starlette and Python compatibility sounds excellent. Let me know if there's anything I can assist with.

(_/)
(•_•)
/>🎉

[kennethreitz]

@coderabbitai can you highlight the differences between the current starlette version and latest?

[amotl]

Thanks! Default branch still shows as master for me.

[kennethreitz]

hmm i'll take another look

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@kennethreitz, as of October 2024, the latest version of Starlette is 0.31.0. This release includes several significant changes and improvements over earlier versions:

• Enhanced ASGI Support: Improved compatibility with the latest ASGI specifications, ensuring better integration with ASGI servers and middleware.
• New Middleware Features: Introduction of new middleware components, such as advanced authentication handlers and improved session management.
• Routing Improvements: More flexible routing options, including support for path converters and enhanced URL matching.
• WebSocket Enhancements: Better support for WebSocket connections, including improved handling of connection lifecycles and error management.
• Performance Optimizations: Various optimizations leading to faster request handling and reduced latency.
• Deprecations and Removals: Some outdated APIs and features have been deprecated or removed to streamline the framework and encourage best practices.

If your project is using an older version of Starlette, updating to the latest version could provide these benefits and improve compatibility with newer Python versions and dependencies. Let me know if you'd like assistance with the update process or a more detailed breakdown of changes from your current version.

🔗 Analysis chain

🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Find the current Starlette version used in the project by searching dependency files.
rg -i 'starlette' requirements*.txt pyproject.toml setup.py

Unrecoverable error: Failed to clone repository

[kennethreitz]

main is now live

[kennethreitz]

@amotl thanks so much for helping!!

[amotl]

You are welcome. Do you want to review such chore PRs like GH-526 or GH-527, or should I just go ahead and merge them as long as they don't break CI?

[kennethreitz]

@amotl go ahead and merge. I'm getting my GitHub notifications fixed still. They all go to an 'unsubscribed' folder in my inbox which is super annoying.

[amotl]

In order to support a linear history on this project, can I ask you to configure its settings like that?

I guess you could also disable Discussions, Projects, and Wiki, in order to trim the tab navigation.

[kennethreitz]

yes will do now

[kennethreitz]

@amotl done

[kennethreitz]

@amotl username on pypi?

[amotl]

On PyPI, I am also amotl.

[amotl]

Another humble request: Please don't use squash merging by default, specifically on a bundled PR where individual commits are, well, individual changes, often unrelated.

[amotl]

Can I humbly ask you to have a closer look at those patches?

• Chore: Format code using Ruff, and fix linter errors #531
• Sandbox: Add tasks configuration to pyproject.toml #532

Afterwards, I think we could think about publishing a release, probably v2.1.0? Will you run the release procedure, or will you add me on PyPI, so I can do it?

[amotl]

Thanks a stack. Those are next, ready for review:

• Sandbox: Add tasks configuration to pyproject.toml #532
• Replace use of apistar package with local API theme files #543
  Coming from Replace apistar with local api theme files #480 that got lost. Thanks, @tabotkevin!

[kennethreitz]

@amotl you now have publishing permissions on PyPi.

[amotl]

Hi again. Thanks for merging all my patches. GH-535 will take more time, so I guess we are now ready to run the release for version 2.1.0? Please upvote and/or add further suggestions.

[amotl]

Changelog

Question

@kennethreitz: When you want me to run the release, can you please provide a few guidelines how you would like the CHANGELOG.md to be updated?

The current change log items look like they have been curated by humans, but there is also a reference to Keep a Changelog. I am not sure what this means.

Thoughts

Edit: Ah, the "Keep a Changelog" conventions effectively mean: Split each change log block into subsections like Added, Changed, Deprecated, Removed, Fixed, Security, as those are apparently must-have categories. However, there are no policies that impose a certain language or style to individual change log items, nor there are suggestions how granular the list should be, correct?

Solution

Please advise accordingly, optimally on the PR itself. Thank you!

• Documentation: Update change log for upcoming version 3.0.0 #552

[amotl]

Dear Kenneth,

we came along a good way since a73e413, cheers. Another round of patches is ready for review and integration, optimally digested and processed in the order outlined below.

With GH-549, I detoured a bit into bot-assisted yak shaving, addressing many suggestions by @coderabbitai. It was an interesting and valuable conversation about code. Currently, I can't provide the same efforts for GH-554, as it easily takes multiple hours to do the bot dance well. Maybe we can refactor and improve that module later, also with bot support?

Let's start with a few chore and maintenance patches.

• CI: Run link checker and build documentation as GHA workflow #557
• Dependencies: Remove aiofiles #556
• Dependencies: Migrate from WhiteNoise to ServeStatic #562
• Sandbox: Enable mypy type checker #560
• Update alabaster requirement from <0.8 to <1.1 #561
• Check that stray ca928be will not get lost.

It's 2024, so I would dearly like to contribute documentation in Markdown format going forward. Please let's add support for it.

• Documentation: Unlock writing in Markdown, using Sphinx/MyST. Add Sphinx extensions "copybutton" and "opengraph". #559

Let's bring back missing features, in order to not cause any regressions with the upcoming release.

• CLI: Re-add command line interface (2024) #549
• GraphQL: Re-add extension and dependencies (2024) #554
• OpenAPI: Refactor module to responder.ext.openapi #555

Let's wrap it up. Should make 3.0.0 instead of 2.1.0?

• Documentation: Update change log for upcoming version 3.0.0 #552

When merging individual PRs, others may need to be refreshed, including resolving conflicts. Just ping me about it. I also don't necessarily expect that you merge them proactively. If you want to keep project management lenient, the most important detail would be to add your acknowledgments or objections to relevant PRs, potentially also on those still in draft mode, to signal if you agree with the general idea of the patch at hand or not. Then, I can easily consider and process the PRs asynchronously.

Thanks a stack for your support.

With kind regards,
Andreas.

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@amotl, thank you for your contributions and for sharing your feedback. I understand that engaging in detailed bot-assisted reviews can be time-consuming, and I appreciate the effort you've put into GH-549. I'll strive to make future interactions more efficient to better support your workflow. If there's anything specific I can assist with regarding GH-554 or any of the other PRs, please let me know.

[amotl]

Hi Kenneth,

in order to move forward, I guess applying an ack-by-timeout procedure on reviewing PRs will also be fine, given that you merged all of my previous PRs without much ado, and pretending that we have a shared mindset to produce a good outcome for the community of Responder users, both in terms of project maintenance, and gradually improving its features on a few minor details.

Please don't hesitate to have your voice also on already-merged-PRs. Because "it's just software", it is reasonably easy to roll back individual changes when there are any concerns about them, even in retrospective. @tabotkevin is also occasionally having an eye, so I guess it will all be just fine to move forward.

I hope you agree with this procedure, otherwise please let me know.

With kind regards,
Andreas.

[kennethreitz]

Yes, I think that's a good plan. Sorry that I've been a little delayed on contributing. I like all the work you've been doing, but have been focused on other things.

My only request is keeping alabaster and being cautious with switching to markdown.

[kennethreitz]

I trust you

[coderabbitai]

Tip

For best results, initiate chat on the files or code changes.

@amotl, thank you for your detailed update and for your continued contributions.

I understand that engaging in detailed bot-assisted reviews can be time-consuming. I'm here to assist in ways that best support your workflow. If you'd like to refactor the module later with bot support, I'd be happy to help.

Adding support for Markdown documentation is a great idea and aligns with modern documentation practices. Let me know if there's anything I can assist with in that effort.

Regarding the upcoming release, moving to version 3.0.0 to reflect the significant updates sounds appropriate.

Thank you for your collaboration and support.

(・ω・)♪

[kennethreitz]

@amotl do you want me to disable coderabbit on this repo?

[amotl]

The bot is sometimes is a bit on the edge of spamming, definitively quite verbose, but it has good intentions, and indeed it was tremendously helpful and supportive on some occasions. For now, unless there are any other objections about it, why not keep it for the time being?

NB: If you are not keen on being spammed in issue tickets, as the bot shines on PRs and conversations about them, just don't mention coderabbit in that conversation. Saying this, maybe it understands a bot command to turn it off on a conversation it was already engaged in?

[kennethreitz]

Sounds great :)Sent from my iPhoneOn Oct 29, 2024, at 6:20 PM, Andreas Motl ***@***.***> wrote: The bot is sometimes is a bit on the edge of spamming, definitively quite verbose, but it has good intentions, and indeed it was tremendously helpful and supportive on some occasions. For now, unless there are any other objections about it, why not keep it for the time being? —Reply to this email directly, view it on GitHub, or unsubscribe.You are receiving this because you were mentioned.Message ID: ***@***.***>

[amotl]

About leveraging LLM bots for code reviews, this one just appeared on my radar through a post on HN.

• https://github.com/marketplace/llamapreview
• https://news.ycombinator.com/item?id=41996859

I am sure there will be more of that in the future. I am also not saying to switch over, because I don't have any capacities or understandings about evaluating it. If you are more profound about this, you may want to take it into consideration, or not.

[kennethreitz]

@amotl I enabled it on this repo! Let's see if it's any good.

[kennethreitz]

Hopefully the bots don't start fighting hahaha

[amotl]

Omg. I am sure they will.

[amotl]

Back to serious work: Why don't the bots automatically perform those kinds of chores for us? ;] 🍀
Until they will do it, it is probably still our job. Please don't forget about enabling the project on RTD:

• Using Read the Docs #564 (comment)

Thank you!

[adrian-kuhn]

Hi Andreas, hi Kenneth
First of all, I love the responder library and I use it in several projects. It's so handy and lightweight - just fantastic. I actively recommend it when someone asks me for an API solution. Many thanks for all of your work with this great piece of software!

I see there's a release on the horizon supporting python 3.10+. Can you make a prediction when this release will be published? We could then align the release planning and the migration to python 3.10+ of our products.

Thank you for your answer,
Adrian

[amotl]

Hi Adrian. I certainly got sidetracked, but will try to come back here soon. It is not much that needs to be done. Thanks for pinging.

[adrian-kuhn]

Hi Andreas, thank you for your answer. Looking forward to it!

Let me know, if I can support you somehow. Unfortunately, I don't have any experience with library implementations and Github colaboration and contribute processes. I would have to learn it first.