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`, `pubnub`, and `requests-toolbelt` to enable some functionality in `civis-python`
```
pip install pandas
pip install pubnub
pip install requests-toolbelt
```
Installation of `pandas` will allow some functions to return `DataFrame` outputs.
Installation of `pubnub` will improve performance in all functions which
wait for a Civis Platform job to complete.
Installation of `requests-toolbelt` will allow streaming file uploads to
Civis via `civis.io.file_to_civis`.
# 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.
=======================
# 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`, `pubnub`, and `requests-toolbelt` to enable some functionality in `civis-python`
```
pip install pandas
pip install pubnub
pip install requests-toolbelt
```
Installation of `pandas` will allow some functions to return `DataFrame` outputs.
Installation of `pubnub` will improve performance in all functions which
wait for a Civis Platform job to complete.
Installation of `requests-toolbelt` will allow streaming file uploads to
Civis via `civis.io.file_to_civis`.
# 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.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
civis-1.4.0.tar.gz
(32.7 kB
view details)
File details
Details for the file civis-1.4.0.tar.gz.
File metadata
- Download URL: civis-1.4.0.tar.gz
- Upload date:
- Size: 32.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
7919ad433829ef2f3369def14e2e9e425b4e9cef3794621dd76cf241d9719236
|
|
| MD5 |
223e95bb227d7db0e118b80b46670973
|
|
| BLAKE2b-256 |
a06e841f6c674af40ecf6e49579db100924b4d53941a25c08154cf3b1ad45434
|
