Metadata-Version: 2.1
Name: datacommons
Version: 1.4.3
Summary: A library to access Data Commons Python API.
Home-page: https://github.com/datacommonsorg/api-python
Author: datacommons.org
Author-email: support@datacommons.org
Maintainer: datacommons.org
Maintainer-email: support@datacommons.org
License: Apache 2.0
Description: # Data Commons Python API
        
        This is a Python library for accessing data in the Data Commons Graph.
        
        > See also: [Data Commons Pandas API](datacommons_pandas/README.md).
        
        
        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](https://docs.datacommons.org/api/setup.html),
        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](http://docs.datacommons.org/api/).
        
        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](https://datacommons.org/colab)!
        
        ## About Data Commons
        
        [Data Commons](https://datacommons.org/) is an open knowledge repository that
        provides a unified view across multiple public data sets and statistics. You can
        view what [datasets](https://datacommons.org/datasets) are currently ingested
        and browse the graph using our [browser](https://browser.datacommons.org/).
        
        ## 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
        
        Note: Always release `datacommons_pandas` when `datacommons` is released.
        
        **If this is your first time releasing to PyPI**, please review the PyPI guide
        starting from the
        [setup section](https://packaging.python.org/tutorials/packaging-projects/#creating-setup-py).
        
        ### Release to Test PyPI
        
        1. In [setup_datacommons.py](setup_datacommons.py) and
          [setup_datacommons_pandas.py](setup_datacommons_pandas.py):
            - Append "-USERNAME" to the package "NAME". For example,
            `NAME = 'foo_package-janedoe123'`.
            - Increment the "VERSION" codes to something that has not been used in your
             test project. This will not affect the production PyPI versioning.
        1. Build the dists:
            ```bash
            rm dist/*
            python3 -m pip install --user --upgrade setuptools wheel
            python3 setup_datacommons.py sdist bdist_wheel
            python3 setup_datacommons_pandas.py sdist bdist_wheel
            ```
        1. Release the dists to TestPyPI:
            ```bash
            python3 -m pip install --user --upgrade twine
            python3 -m twine upload --repository testpypi dist/*
            ```
        
        ### Release to Production PyPI
        1. In [setup_datacommons.py](setup_datacommons.py) and
          [setup_datacommons_pandas.py](setup_datacommons_pandas.py):
            - Revert the package name to `datacommons` and `datacommons_pandas`
            - Update and double check "VERSION"
        1. Update [CHANGELOG.md](CHANGELOG.md) and
          [datacommons_pandas/CHANGELOG.md](datacommons_pandas/CHANGELOG.md)
        1. Build the dists:
            ```bash
            rm dist/*
            python3 -m pip install --user --upgrade setuptools wheel
            python3 setup_datacommons.py sdist bdist_wheel
            python3 setup_datacommons_pandas.py sdist bdist_wheel
            ```
        1. Release the dists to PyPI:
            ```bash
            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](https://github.com/google/datacommons/issues) page. For all other
        questions, please send an email to `support@datacommons.org`.
        
        **Note** - This is not an officially supported Google product.
        
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Software Development
Requires-Python: >=2.7
Description-Content-Type: text/markdown
