Skip to content

Fix comments, modify setup.py in preparation for release. #114

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.

Sign up for GitHub

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

Merged
Spaceenter merged 1 commit into from
Jan 30, 2020
Merged

Fix comments, modify setup.py in preparation for release. #114

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,5 +1,19 @@
# Changelog

## 1.06

**Date** - 01/29/2020

**Release Tag** - [v1.0.6](https://github.com/datacommonsorg/api-python/releases/tag/v1.0.6)

**Release Status** - Current head of branch [`master`](https://github.com/datacommonsorg/api-python/tree/master)

New features added to the Python Client API

- Add a new API for getting related places.



## 1.0.5

**Date** - 01/27/2020
Expand Down
20 changes: 10 additions & 10 deletions datacommons/places.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,25 +73,25 @@ def get_places_in(dcids, place_type):


def get_related_places(dcids, population_type, constraining_properties={},
measured_prop='count',
measured_property='count',
stat_type='measured', within_place='',
per_capita=False, same_place_type=False):
""" Returns :obj:`Place`s related to :code:`dcids` for the given constraints.

Args:
dcids (:obj:`iterable` of :obj:`str`): Dcids to get contained in places.
dcids (:obj:`iterable` of :obj:`str`): Dcids to get related places.
population_type (:obj:`str`): The type of statistical population.
constraining_properties (:obj:`map` from :obj:`str` to :obj:`str`, optional):
A map from constraining property to the value that the
:obj:`StatisticalPopulation` should be constrained by.
A map from constraining property to the value that the
:obj:`StatisticalPopulation` should be constrained by.
measured_property (:obj:`str`): The measured property.
stat_type (:obj:`str`): The statistical type for the observation.
within_place(:obj:`str`): Optional, the place that all the related places
are contained in.
within_place(:obj:`str`): Optional, the DCID of the place that all the
related places are contained in.
per_capita(:obj:`bool`): Optional, whether to take into account
`PerCapita` when compute the relatedness.
`PerCapita` when compute the relatedness.
same_place_type(:obj:`bool`): Optional, whether to require all the
related places under the same ancestor place.
related places under the same place type.

Returns:
The returned :obj:`Place`'s are formatted as a :obj:`dict` from a given
Expand All @@ -106,7 +106,7 @@ def get_related_places(dcids, population_type, constraining_properties={},
`Santa Clara county <https://browser.datacommons.org/kg?dcid=geoId/06085>`
Specifying the :code:`dcids` as a :obj:`list` result in the following.

>>> get_places_in(["geoId/06"], "Person", {
>>> get_related_places(["geoId/06"], "Person", {
"age": "Years21To64",
"gender": "Female"
}, "count", "measured")
Expand All @@ -128,7 +128,7 @@ def get_related_places(dcids, population_type, constraining_properties={},
'dcids': dcids,
'populationType': population_type,
'pvs': pvs,
'measuredProperty': measured_prop,
'measuredProperty': measured_property,
'statType': '', # TODO: Set to stat_type when having it in BT data.
'withinPlace': within_place,
'perCapita': per_capita,
Expand Down
2 changes: 1 addition & 1 deletion setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
EMAIL = 'support@datacommons.org'
AUTHOR = 'datacommons.org'
REQUIRES_PYTHON = '>=3.6.0'
VERSION = '1.0.5'
VERSION = '1.0.6'

REQUIRED = [
'httplib2',
Expand Down