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 git+git://github.com/civisanalytics/civis-python.git
```
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.
# 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 git+git://github.com/civisanalytics/civis-python.git
```
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.
# 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.0.0.tar.gz
(25.7 kB
view details)
File details
Details for the file civis-1.0.0.tar.gz.
File metadata
- Download URL: civis-1.0.0.tar.gz
- Upload date:
- Size: 25.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9fcc17dde4cd94f45e48c286247280c64832c59748684aad7444cad26efe4277
|
|
| MD5 |
c66a89edabedbdc4d1f0a7ecd2dce21c
|
|
| BLAKE2b-256 |
9b99944f309809be9f91a92967436a7ce701899607b5b48a3bb1227f7ae154e4
|
