v15: refactor / api change: make offline mode the default, while retaining optional online support.

hhursev / recipe-scrapers

Python package for scraping recipes data

MIT License

1.61k stars 505 forks source link

v15: refactor / api change: make offline mode the default, while retaining optional online support. #1021

Closed jayaddison closed 3 months ago

jayaddison commented 3 months ago

Trying to find a reasonable path to:

Provide migration support for existing users and developers.
Create a 15.0.0-rc2 release candidate.
Make it reasonably straightforward to compose a utility method/module with all the proxy/timeout/other support on top of the existing methods.
Clean up the public API a bit generally.

Fixes:

Resolves #1023.

jayaddison commented 3 months ago

Almost ready, but a few more tweaks to apply here; I'd like to add some migration notes to the README.rst, and have begun work on that. Moving to 'draft' until ready.

jayaddison commented 3 months ago

@jknndy I've made a few changes to this branch since your last review, and wouldn't mind another re-review if possible?

A compare view for the changes since your previous review is: https://github.com/hhursev/recipe-scrapers/compare/26437902a9c2e6eee6008dc729e8e2c20c045871...51cfec3e22670938aeb122ddb75a6f5346f57e03

(except for merge commit 332d57ee7bca7d969f8930c31220a5e1b14ab06c - for some reason including that includes unrelated base-branch changes in the diff)

jknndy commented 3 months ago

@jayaddison, looks good to me!

Great comments throughout, will definitely be appreciated by future users!

jayaddison commented 3 months ago

Thanks again @jknndy - I think I'll try creating that Release Candidate (-rc2) release with these changes in place.