Skip to content

Commit 09c25a3

Browse files
authored
Fixed docs and updated changelog (#89)
* Amended documentation for creating a key. * Updated CHANGELOG * Spacing * Added 0.4.3 changes * Added 0.x to changelog
1 parent cf2bd31 commit 09c25a3

2 files changed

Lines changed: 59 additions & 7 deletions

File tree

CHANGELOG.md

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,37 @@
11
# Changelog
2+
3+
## 1.0.0
4+
5+
**Date** - 8/9/2019
6+
7+
**Release Tag** - [v1.0.0](https://github.com/datacommonsorg/api-python/releases/tag/v1.0.0)
8+
9+
**Release Status** - Current head of branch [`stable-1.x`](https://github.com/datacommonsorg/api-python/tree/stable-1.x)
10+
11+
New release of the Python Client API.
12+
13+
- New functions in the API built on top of the [Data Commons REST API](https://github.com/datacommonsorg/mixer).
14+
- `get_property_labels`
15+
- `get_property_values`
16+
- `get_triples`
17+
- `get_populations`
18+
- `get_observations`
19+
- `get_places_in`
20+
- New tests and examples checked into `datacommons/test` and `datacommons/examples`
21+
- Full documentation released on [readthedocs](https://datacommons.readthedocs.io/en/latest/)
22+
23+
## 0.4.3
24+
25+
**Date** - 8/13/2019
26+
27+
**Release Tag** - [v0.4.3](https://github.com/datacommonsorg/api-python/releases/tag/v0.4.3)
28+
29+
**Release Status** - Latest on [PyPI](https://pypi.org/project/datacommons/). Current head of branch [`stable-0.x`](https://github.com/datacommonsorg/api-python/tree/stable-0.x).
30+
31+
Patch release that fixes bugs in `datacommons.Client`.
32+
33+
- Functions `get_cities` and `get_states` now provides `typeOf` constraints in their datalog queries.
34+
35+
## 0.x
36+
37+
Initial release of the Data Commons API.

docs/source/started.rst

Lines changed: 23 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -3,11 +3,13 @@
33
Getting Started
44
===============
55

6-
To get started using the Python Client API requires three steps.
6+
To get started using the Python Client API requires four steps.
77

8-
- Instal the API using :code:`pip`
9-
- Create an API key on `Google Cloud Platform <https://cloud.google.com/>`_ (GCP)
10-
- Enable the API key with the Python Client API
8+
- Install the API using :code:`pip`
9+
- Create an API key on `Google Cloud Platform <https://cloud.google.com/>`_ (GCP)
10+
- Enable the *Data Commons API* on GCP. Note that this is separate from the
11+
*Python Client API*.
12+
- Provide the API key to the Python Client API and begin developing.
1113

1214
Installing the Python Client API
1315
--------------------------------
@@ -44,11 +46,25 @@ Follow these steps to create your own key.
4446
.. _`GCP Project`: https://console.developers.google.com/projectcreate
4547
.. _`enabling billing`: https://cloud.google.com/billing/docs/how-to/modify-project#enable_billing_for_a_project
4648

49+
Enable the Data Commons API
50+
---------------------------
51+
52+
Additionally, you will need to enable the *Data Commons API* on GCP which is
53+
separate from the *Python Client API*. This service enables the Python Client
54+
API to call our REST service and access data in our knowledge graph. To enable
55+
the API, do the following.
56+
57+
1. Navigate to the `Data Commons API`_ in the Google APIs Console.
58+
2. Click the :code:`Enable` button and wait for the process to complete.
59+
60+
.. _`Data Commons API`: https://console.developers.google.com/apis/api/api.datacommons.org/overview?pli=1
61+
4762
Using the Python Client API
4863
---------------------------
4964

50-
Once you have the API key, you can get started using the Data Commons Python
51-
Client API. There are two ways to enable your key in the API package.
65+
With the API key created and Data Commons API activated, we can now get started
66+
using the Data Commons Python Client API. There are two ways to provide your key
67+
to the Python Client API package.
5268

5369
1. You can set the API key by calling :py:func:`datacommons.utils.set_api_key`.
5470
Start by importing :code:`datacommons`, then set the API key like so.
@@ -79,6 +95,6 @@ Client API. There are two ways to enable your key in the API package.
7995
This route is particularly useful if you are building applications that
8096
depend on this API, and are deploying them to hosting services.
8197

82-
You're now ready to go! From here you can view our tutorials on how to use the
98+
You are now ready to go! From here you can view our tutorials on how to use the
8399
API to perform certain tasks, or see a full list of functions, classes and
84100
methods available for use by navigating to `modules <modules.html>`_

0 commit comments

Comments
 (0)