Skip to content

Commit c5786fb

Browse files
tjanntjann
authored
Remove API key requirement and rebrand to Python API (not Python Clie… (#131)
1 parent 0293ecb commit c5786fb

24 files changed

Lines changed: 56 additions & 189 deletions

‎.github/ISSUE_TEMPLATE/python-api-v1-0-0-feedback.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
---
22
name: Python API v1.0.0 Feedback
3-
about: Feedback for the new Python Client API
3+
about: Feedback for the new Python API
44
title: "[API v1.0.0 Feedback] description of feedback"
55
labels: python api feedback
66
assignees: ACscooter

‎CHANGELOG.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88

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

11-
New features added to the Python Client API
11+
New features added to the Python API
1212

1313
- Add get_stats API to get observations given a StatisticalVariable and place dcids.
1414

@@ -25,7 +25,7 @@ Bugs fixed in new release
2525

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

28-
New features added to the Python Client API
28+
New features added to the Python API
2929

3030
- Handle and ignore NaN in API argument.
3131

@@ -41,7 +41,7 @@ Bugs fixed in new release
4141

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

44-
New features added to the Python Client API
44+
New features added to the Python API
4545

4646
- Use six package for urllib.
4747

@@ -53,7 +53,7 @@ New features added to the Python Client API
5353

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

56-
New features added to the Python Client API
56+
New features added to the Python API
5757

5858
- Support python 2.7.
5959

@@ -65,7 +65,7 @@ New features added to the Python Client API
6565

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

68-
New features added to the Python Client API
68+
New features added to the Python API
6969

7070
- Add a new API for getting related places.
7171

@@ -79,7 +79,7 @@ New features added to the Python Client API
7979

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

82-
New features added to the Python Client API
82+
New features added to the Python API
8383

8484
- Remove the dependency on Pandas and Numpy in package dependency.
8585
- Replace requests with urllib.
@@ -93,7 +93,7 @@ New features added to the Python Client API
9393

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

96-
New features added to the Python Client API
96+
New features added to the Python API
9797

9898
- Remove the dependency on Pandas.
9999

@@ -106,7 +106,7 @@ New features added to the Python Client API
106106

107107
**Release Status** - Current head of branch [`stable-1.x`](https://github.com/datacommonsorg/api-python/tree/stable-1.x)
108108

109-
New features added to the Python Client API
109+
New features added to the Python API
110110

111111
- Added two new functions `get_pop_obs` and `get_place_obs`
112112
- SPARQL query is now supported as a function `query` instead of a class.
@@ -123,7 +123,7 @@ Bugs fixed in new release
123123

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

126-
New release of the Python Client API.
126+
New release of the Python API.
127127

128128
- New functions in the API built on top of the [Data Commons REST API](https://github.com/datacommonsorg/mixer).
129129
- `get_property_labels`

‎README.md‎

Lines changed: 0 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,6 @@ Once the package is installed, import `datacommons`.
99

1010
import datacommons as dc
1111

12-
You will also need to provision an API key by enabling the Data Commons API on
13-
GCP. Once you have the API key, simply add the following line to your code.
14-
15-
dc.set_api_key('YOUR-API-KEY')
16-
1712
For more detail on getting started with the API, please visit
1813
[Getting Started](http://docs.datacommons.org/api/).
1914

‎datacommons/__init__.py‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -15,10 +15,10 @@
1515
# Data Commons SPARQL query support
1616
from datacommons.query import query
1717

18-
# Data Commons Python Client API
18+
# Data Commons Python API
1919
from datacommons.core import get_property_labels, get_property_values, get_triples
2020
from datacommons.places import get_places_in, get_related_places, get_stats
2121
from datacommons.populations import get_populations, get_observations, get_pop_obs, get_place_obs
2222

23-
# Other utilities
24-
from .utils import set_api_key
23+
# Other utilities
24+
from .utils import set_api_key

‎datacommons/core.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API Core.
14+
""" Data Commons Python API Core.
1515
1616
Provides primitive operations for working with collections of nodes. For a
1717
collection of nodes identified by their dcids, this submodule implements the

‎datacommons/examples/core.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API examples.
14+
""" Data Commons Python API examples.
1515
1616
Basic demo for get_property_labels, get_property_values, and get_triples.
1717
"""

‎datacommons/examples/places.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API examples.
14+
""" Data Commons Python API examples.
1515
1616
Basic demo for get_places_in
1717
"""

‎datacommons/examples/populations.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API examples.
14+
""" Data Commons Python API examples.
1515
1616
Basic demo for get_populations and get_observations.
1717
"""

‎datacommons/examples/query.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API examples.
14+
""" Data Commons Python API examples.
1515
1616
Example on how to use the Client API SPARQL query wrapper.
1717
"""

‎datacommons/places.py‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
1212
# See the License for the specific language governing permissions and
1313
# limitations under the License.
14-
""" Data Commons Python Client API Places Module.
14+
""" Data Commons Python API Places Module.
1515
1616
Provides convenience functions for working with Places in the Data Commons
1717
Graph. This submodule implements the ability to access :obj:`Place`'s

0 commit comments

Comments
 (0)