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

add support for cloudflare's 3.0 python package #9938

Open
mahtin opened this issue May 10, 2024 · 3 comments
Open

add support for cloudflare's 3.0 python package #9938

mahtin opened this issue May 10, 2024 · 3 comments
Assignees
Labels
area: dns priority: significant Issues with higher than average priority that do not need to be in the current milestone.

Comments

@mahtin
Copy link

mahtin commented May 10, 2024

The following ...

install_requires = [
    'cloudflare>=1.5.1',
    'setuptools>=41.6.0',
]

... in certbot-dns-cloudflare folder needs updating to cloudflare<=2.19.*. This is explained at github.com/cloudflare/python-cloudflare README file. It's become kinda urgent because of a pending 3.x release that's not code compatible. Certbot will continue to be 100% compatible with the 2.19.* releases.

BTW: Upgrading the cloudflare requirements from 1.5.1 to a newer release is highly recommended as big fixes and major improvements (like keepalive etc) are in the newer releases.

This was referenced May 11, 2024
@bmw
Copy link
Member

bmw commented May 11, 2024

thanks for the heads up!

poking around https://github.com/cloudflare/python-cloudflare and in particular cloudflare/python-cloudflare#191 (comment), it sounds like 2.19.* will receive security fixes for 6 months, after which it will be abandoned. we should try to switch over to 3.0 before then

our code supporting both 2.19 and 3.0 may be nice depending on the versions of the cloudflare libraries available in LTS linux distros where the certbot packages are receiving updates. i think ensuring we work with 3.0 is most important though

i updated our setup.py file in #9940. i'll leave this issue open to track the 3.0 compatibility work

@bmw bmw changed the title Pinning required for cloudflare in requirements.txt - urgent handle the breaking changes in the cloudflare's python package May 11, 2024
@bmw bmw added area: dns priority: significant Issues with higher than average priority that do not need to be in the current milestone. labels May 11, 2024
@bmw bmw added this to the 2.11.0 milestone May 11, 2024
@mahtin
Copy link
Author

mahtin commented May 11, 2024

The 2.19.* release(s) will get support from me for quite some time, plus certbot's usage (if I may say) of the Cloudflare API is quite basic (which is a good thing). That said, it's a very stable library and unlikely to need any updates.

For 3.*, when it's released, you can't decide what to do. Cloudflare is the supporting entity for that library. Long term, that's your go-to choice.

@bmw
Copy link
Member

bmw commented May 14, 2024

got it. thanks for the additional info ❤️

because of that, 3.0 not being out yet, and us having #9940 which should be merged soon, i'm dropping the priority of this slightly. if someone on the certbot team disagrees with this decision, feel free to bump it back up

@bmw bmw removed this from the 2.11.0 milestone May 14, 2024
@bmw bmw changed the title handle the breaking changes in the cloudflare's python package add support for cloudflare's 3.0 python package May 14, 2024
@wgreenberg wgreenberg self-assigned this May 22, 2024
bmw added a commit that referenced this issue May 30, 2024
while working on #9938, i updated our dependencies which updated mypy introducing new errors that mypy wanted me to fix. i think this makes the regularly necessary process of updating our dependencies too tedious and we should instead pin our linters that do this to a specific version and update them manually as desired. we already do this with pylint in the lines above my changes in this PR for the same reason
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area: dns priority: significant Issues with higher than average priority that do not need to be in the current milestone.
Projects
None yet
Development

No branches or pull requests

3 participants