Skip to main content

Python wrapper for Coda.io API

Project description

Python wrapper for Coda.io API

CodaAPI Code style: black PyPI Documentation Status

Installation

pip install codaio

Config via environment variables

The following variables will be called from environment where applicable:

  • CODA_API_ENDPOINT (default value https://coda.io/apis/v1beta1)
  • CODA_API_KEY - your API key to use when initializing document from environment

Quickstart using raw API

Coda class provides a wrapper for all API methods.

from codaio import Coda

coda = Coda('YOUR_API_KEY')

coda.list_docs()
coda.create_doc('My document')

For full API reference for Coda class see documentation

Quickstart using codaio objects

codaio implements convenient classes to work with Coda documents: Document, Table, Row, Column and Cell.

from codaio import Document

doc = Document.from_environment('YOUR_DOC_ID')
doc.list_tables()

For full API reference for Document class see documentation

Documentation

codaio documentation lives at readthedocs.io

Using raw API

codaio implements all methods of raw api in a convenient python manner. So API's listDocs becomes in codaio Coda.list_docs(). Get requests return a dictionary. Put, delete and post return a requests Response object.

All methods of Coda class are describe in the documentation.

Project details


Download files

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

Source Distribution

codaio-0.3.2.tar.gz (8.0 kB view hashes)

Uploaded Source

Built Distribution

codaio-0.3.2-py3-none-any.whl (8.0 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page