Skip to content

CHANGELOG.md

Latest commit

 

History

History
310 lines (167 loc) · 10.4 KB

CHANGELOG.md

File metadata and controls

310 lines (167 loc) · 10.4 KB

Changelog

2.1.6

Date - 01/28/2026

Release Tag - v2.1.6

Release Status - Current head of branch master

This is a patch update that adds support for resolving indicators (StatisticalVariables and Topics) from natural language queries via the resolve endpoint. It introduces a new fetch_indicators method and updates the Candidate model to include match scores and types.

2.1.5

Date - 01/12/2026

Release Tag - v2.1.5

Release Status - Current head of branch master

This is a patch update that adds support for per-request API key overrides using a context manager.

2.1.4

Date - 10/31/2025

Release Tag - v2.1.4

Release Status - Current head of branch master

This is a patch update that allows the client to use an API key, if specified, for instance validation when a URL is provided during initialization. This is useful for validating against non-production environments or custom Data Commons instances that require authentication.

2.1.3

Date - 10/21/2025

Release Tag - py2.1.3

Release Status - Current head of branch master

This is a minor fix that removes text validation on the surface_header_value parameter so that additional Data Commons surfaces can be added without re-releasing the package. This is only used by Data Commons to track usage across its platforms, and does not change the behavior of the client.

2.1.2

Date - 10/16/2025

Release Tag - py2.1.2

Release Status - Current head of branch master

This update adds an optional surface_header_value parameter to the Data Commons Client that is used internally by Data Commons to track usage across its platforms. Other Data Commons services make calls to the Python client and pass in this parameter, but it is not intended for public use and does not affect the behavior of the client.

2.1.1

Date - 06/10/2025

Release Tag - py2.1.1

Release Status - Current head of branch master

This is an under-the-hood update to use pydantic for data models.

2.1.0

Date - 05/08/2025

Release Tag - py2.1.0

Release Status - Current head of branch master

Bugs fixed:

  • Remove auto-flattening for unpack_arcs
  • Fix unpack_arcs when multiple arcs are in the node response

Other improvements:

  • Clarify parent_entity requirements for observations_dataframe
  • Updated some tutorials and notebooks to use the v2 client
  • Fix install command and refine documentation
  • Handle empty/malformed REST API node responses
  • Make renamed methods backwards compatible

New features:

  • Add helpers to extract data from NodeResponse arcs
  • Add convenient ways to fetch parents and children of given entities

2.0.0

Date - 04/08/2025

Release Tag - py2.0.0

Release Status - Current head of branch master

Initial v2 of the Data Commons API Python client library.

1.4.4

Date - 01/12/2026

Release Tag - py1.4.4

Release Status - Current head of branch master

Added deprecation notice to legacy datacommons package.

1.4.3

Date - 11/10/2020

Release Tag - py1.4.3

Release Status - Current head of branch master

Bugs fixed in new release

  • Return empty data structures instead of erroring when no data is available.

1.4.2

Date - 09/16/2020

Release Tag - py1.4.2

Release Status - Current head of branch master

New features added to the Python API

  • Added batching to get_stat_all to handle querying for many StatisticalVariables across many Places.

1.4.1

Date - 08/25/2020

Release Tag - py1.4.1

Release Status - Current head of branch master

New features added to the Python API

  • get_stat_value: returns a single value for the specified Place and StatisticalVariable.
  • get_stat_series: returns a single time series dict for the specified Place and StatisticalVariable.
  • get_stat_all: returns a nested dictionary of all possible time series for each Place and StatisticalVariable pair.

1.3.0

Date - 07/28/2020

Release Tag - v1.3.0

Release Status - Current head of branch master

New features added to the Python API

  • Option to use the API without providing API key.
  • New options to get_stats: measurement_method, unit, and obs_period for finer-grain control over returned statistics.

Bugs fixed in new release

  • Elegantly handle sparse responses from query.

1.2.0

Date - 06/04/2020

Release Tag - v1.2.0

Release Status - Current head of branch master

New features added to the Python API

  • Add get_stats API to get observations given a StatisticalVariable and place dcids.

Bugs fixed in new release

  • Check Null and empty data in REST API response field to avoid KeyError.

1.1.0

Date - 04/10/2020

Release Tag - v1.1.0

Release Status - Current head of branch master

New features added to the Python API

  • Handle and ignore NaN in API argument.

Bugs fixed in new release

  • Various small fix.

1.0.9

Date - 02/04/2020

Release Tag - v1.0.9

Release Status - Current head of branch master

New features added to the Python API

  • Use six package for urllib.

1.0.7

Date - 02/04/2020

Release Tag - v1.0.7

Release Status - Current head of branch master

New features added to the Python API

  • Support python 2.7.

1.0.6

Date - 01/29/2020

Release Tag - v1.0.6

Release Status - Current head of branch master

New features added to the Python API

  • Add a new API for getting related places.

1.0.5

Date - 01/27/2020

Release Tag - v1.0.5

Release Status - Current head of branch master

New features added to the Python API

  • Remove the dependency on Pandas and Numpy in package dependency.
  • Replace requests with urllib.

1.0.2

Date - 11/6/2019

Release Tag - v1.0.2

Release Status - Current head of branch master

New features added to the Python API

  • Remove the dependency on Pandas.

1.0.1

Date - 10/2/2019

Release Tag - v1.0.1

Release Status - Current head of branch stable-1.x

New features added to the Python API

  • Added two new functions get_pop_obs and get_place_obs
  • SPARQL query is now supported as a function query instead of a class.
  • Added documentation on how to provision an API key and provide it to the API

Bugs fixed in new release

  • Fixed various typos and formatting issues in the documentation.
  • If the index of the pandas.Series passed into functions such as get_populations and get_observations was not contiguous, then the assignment step would not properly align the values returned by calling the function. This is because the pandas.Series returned by the function would have a different index than the given series. This is fixed by assigning the index of the returned series to that of the given series.

1.0.0

Date - 8/9/2019

Release Tag - v1.0.0

New release of the Python API.

  • New functions in the API built on top of the Data Commons REST API.
    • get_property_labels
    • get_property_values
    • get_triples
    • get_populations
    • get_observations
    • get_places_in
  • New tests and examples checked into datacommons/test and datacommons/examples
  • Full documentation released on readthedocs

0.4.3

Date - 8/13/2019

Release Tag - v0.4.3

Release Status - Latest on PyPI. Current head of branch stable-0.x.

Patch release that fixes bugs in datacommons.Client.

  • Functions get_cities and get_states now provides typeOf constraints in their datalog queries.

0.x

Initial release of the Data Commons API.