Skip to main content
Join the official 2020 Python Developers SurveyStart the survey!

A library to access Data Commons Python API.

Project description

Data Commons Python API

This is a Python library for accessing data in the Data Commons Graph.

See also: Data Commons Pandas API.

To get started, install this package from pip.

pip install datacommons

Once the package is installed, import datacommons.

import datacommons as dc

If you would like to provide an API key, follow the steps in Setting up access to the Data Commons API, add the following line to your code:

dc.set_api_key('YOUR-API-KEY')

Data Commons does not charge users, but uses the API key for understanding API usage.

For more detail on getting started with the API, please visit our API Overview.

When you are ready to use the API, you can refer to datacommons/examples for examples on how to use this package to perform various tasks. More tutorials and documentation can be found on our tutorials page!

About Data Commons

Data Commons is an open knowledge repository that provides a unified view across multiple public data sets and statistics. You can view what datasets are currently ingested and browse the graph using our browser.

License

Apache 2.0

Development

The Python API currently supports python>=2.7.

To test, run:

$ ./run_tests_local.sh

To debug the continuous integration tests, run:

$ cloud-build-local --config=cloudbuild.yaml --dryrun=false .

Both commands will run the same set of tests.

To run the examples:

$ python -m datacommons.examples.XXX

where XXX is the module you want to run.

Release to PyPI

Note: Always release datacommons_pandas when datacommons is released. See the datacommons_pandas README.

If this is your first time releasing to PyPI, please review the PyPI guide starting from the setup section.

Summary:

Test on TestPyPI

Similar to regular PyPI release, except:

  1. Append "-USERNAME" to the package "NAME". For example, NAME = 'datacommons-foobar'.
  2. Increment the "VERSION" code to something that has not been used in your test project. This will not affect the production PyPI versioning.

Here are some helpful commands:

  • Build the dist
    python3 -m pip install --user --upgrade setuptools wheel
    python3 setup_datacommons.py sdist bdist_wheel
    
  • Release the dist to TestPyPI.
    python3 -m pip install --user --upgrade twine
    python3 -m twine upload --repository testpypi dist/*
    

Release to Production PyPI

  • Double check "VERSION" in setup_datacommons.py
  • Update CHANGELOG.md for a new version
  • Clear the dist folder: rm dist/*
  • Build the dist
    python3 -m pip install --user --upgrade setuptools wheel
    python3 setup_datacommons.py sdist bdist_wheel
    
  • Release the dist to TestPyPI.
    python3 -m pip install --user --upgrade twine
    twine upload dist/*
    

Support

For general questions or issues about the API, please open an issue on our issues page. For all other questions, please send an email to support@datacommons.org.

Note - This is not an officially supported Google product.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for datacommons, version 1.4.2
Filename, size File type Python version Upload date Hashes
Filename, size datacommons-1.4.2-py3-none-any.whl (75.7 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size datacommons-1.4.2.tar.gz (17.3 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page