Metadata-Version: 2.1
Name: octane
Version: 1.0.11
Summary: Python bindings for the Octane API
Home-page: https://github.com/getoctane/octane-python
Author: Octane
Author-email: support@getoctane.io
License: MIT
Project-URL: Bug Tracker, https://github.com/getoctane/octane-python/issues
Project-URL: Documentation, https://getoctane.io/docs/api/python
Project-URL: Source Code, https://github.com/getoctane/octane-python
Keywords: octane api
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=2.7, !=3.0.*, !=3.1.*, !=3.2.*, !=3.3.*
Description-Content-Type: text/x-rst
License-File: LICENSE

Official Octane Bindings for Python
===================================

A Python library for Octane's API.


Setup
-----

You can install this package by using the pip tool and installing:

    $ pip install octane


Setting up a Octane Account
---------------------------

Sign up for Octane at https://cloud.getoctane.io/.

Using the Octane API
--------------------

Documentation for the python bindings can be found alongside Octane's other bindings here:

- https://getoctane.io/docs
- https://getoctane.io/docs/api/python

In the standard documentation (the first link), most of the reference pages will have examples in Octane's official bindings (including Python). Just click on the Python tab to get the relevant documentation.

In the full API reference for python (the second link), the right half of the page will provide example requests and responses for various API calls.
