Metadata-Version: 1.0
Name: civis
Version: 1.1.0
Summary: Access the Civis Platform API
Home-page: https://www.civisanalytics.com
Author: Civis Analytics Inc
Author-email: opensource@civisanalytics.com
License: UNKNOWN
Description: Civis API Python Client
        =======================
        
        # Introduction
        
        The Civis API Python client is a Python package that helps analysts and
        developers interact with the Civis Platform. The package includes a set of
        tools around common workflows as well as a convenient interface to make
        requests directly to the Civis API. See the
        [full documentation](https://civis-python.readthedocs.io) for more details.
        
        
        # Installation
        
        1. Get a Civis API key [(instructions)](https://civis.zendesk.com/hc/en-us/articles/216341583-Generating-an-API-Key)
        2. Add a `CIVIS_API_KEY` environment variable.
        3. You can add the following to `.bash_profile` for bash
            ```
            export CIVIS_API_KEY="alphaNumericApiK3y"
            ```
        4. Source your `.bash_profile`
        5. Install the package
        
            ```
            pip install civis
            ```
        6. Optionally, install `pandas` to enable some functionality in `civis-python`
        
            ```
            pip install pandas
            ```
        
        # Usage
        
        `civis-python` includes a number of wrappers around the Civis API for
        common workflows.
        
        ```python
        import civis
        df = civis.io.read_civis(table="my_schema.my_table",
                                 database="database",
                                 use_pandas=True)
        ```
        
        The Civis API may also be directly accessed via the `APIClient` class.
        
        ```python
        import civis
        client = civis.APIClient()
        database = client.databases.list()
        ```
        
        See the [full documentation](https://civis-python.readthedocs.io) for a more
        complete user guide.
        
        # Build Documentation Locally
        To build the API documentation locally
        
        ```bash
        cd docs
        make html
        ```
        
        Then open `docs/build/html/index.html`.
        
        Note that this will use your API key in the `CIVIS_API_KEY` environment
        variable so it will generate documentation for all the endpoints that you have access to.
        
        # Contributing
        
        See `CONTIBUTING.md` for information about contributing to this project.
        
        
        # License
        
        BSD-3
        
        See `LICENSE.md` for details.
        
Platform: UNKNOWN
