Releases: OliverSherouse/wbdata
Releases · OliverSherouse/wbdata
v1.0.0
WBData v1.0.0
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.
- 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
Version 0.3.0 post release
This post release fixes ReadTheDocs integration and GitHub Actions, and also adds some additional information to pypi.
Release of Version 0.3.0
After several years, version 0.3.0 is ready! Changes for this release include:
- Dropping support for Python <= 3.5
- Use of the World Bank API version 2
- Elimination of the "display" argument in search functions. Instead, search functions return lists that print out a table when expressed directly in a shell or notebook
- Ability to specify source for data retrieval
- A new "last updated" attribute on returned data objects (including Pandas objects)
- An option to bypass the cache
- The ability to specify non-annual dates
As well as massively improved testing and a number of bug fixes
Many thanks for contributions from:
- Dominic Kwok (@dominickwok)
- James Remeika (@remeika)
- David Lemayian (@DavidLemayian
- Max Ghenis (@MaxGhenis)
- Gábor Lipták (@gliptak)