feat: v1.0 refactor & rewrite #69
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
OliverSherouse
force-pushed
the
refactor
branch
from
7364f13 to
208da1f
Compare
The 1.0 release of wbdata is not quite a full rewrite, but is pretty much the next best thing. The architecture has been reworked, function and argument names have been changed to be more consistent and clear, and a few dependencies have been added for better and more reliable functionality. Features: * Date arguments can now be strings, not just datetime.datetime objects. Strings can be in the year, month, or quarter formats used by the World Bank API or in any other format that can be handled by [dateparser][https://dateparser.readthedocs.io/en/latest/]. * Default cache behavior can be configured with environment variables, including the path, TTL, and max number of items to cache. See Cache Module documentation for details. * Users can now create Client objects if they want to set cache behavior programmatically have multiple caches, or supply their own requests Session. * Caching is now provided using the shelved_cache and cachetools libraries. Since a lot of annoying bugs seemed to come from wbdata's home-rolled cache implementation, this should be a good quality-of-life improvement for many people. * Type annotations are available. Breaking API Changes: * Supported version of Python are now 3.8+. * All of the metadata retrieval functions have been renamed to their plural forms to reflect the fact that they always return a sequence: * The functions search_countries and search_indicators have been removed. Searching by name is now available using the query parameter of the get_countries and get_indicators functions. * The parameter data_date has been renamed date. * The parameter convert_dates has been renamed parse_dates. * The parameter cache with a default value True has been replaced with a parameter skip_cache with a default value of False.
OliverSherouse
force-pushed
the
refactor
branch
from
e47eb24 to
636cd8f
Compare
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.