A Python module for using the Plasticity API.
This module is available on PyPi and can be installed with pip, a package manager for Python. To install, just run:
pip install plasticity
To install from source (for development, etc.), run:
pip install git+https://github.com/plasticityai/plasticity-python.git
Getting started with the Plasticity API is easy. Simply create a Plasticity
object and you can start using it.
The Plasticity
object needs your API credentials. You can either pass these
directly to the constructor (see the code below) or via environment variables.
from plasticity import Plasticity
plasticity = Plasticity('<YOUR_TOKEN>')
Alternately, a Plasticity constructor without these parameters will look for
the PLASTICITY_API_KEY
variable inside the current environment. We suggest storing your credentials as environment variables so that you don't
accidentally post them somewhere public.
from plasticity import Plasticity
plasticity = Plasticity()
Generally, the library attempts to mirror the Plasticity API service as closely as possible. It also makes several helper classes available to quickly analyze and use the API's responses.
from plasticity import Plasticity
plasticity = Plasticity('<YOUR_TOKEN>')
result = plasticity.sapien.core.post('This is an example of the Plasticity python package.')
print(result) # A pretty form of the `Response` object
Above you'll notice the format for these calls is usually:
plasticity.<service>.<endpoint>.{post|get}(<params>)
.
Additional documentation for endpoint calls can be found in the corresponding
endpoint file, located in plasticity/<service>/<endpoint>.py
.
These calls will return a Response
object with the API data, or an error
if one occurred.
from plasticity import Plasticity
plasticity = Plasticity('<YOUR_TOKEN>')
result = plasticity.sapien.core.post('If this works, error will be False.')
print(result.error) # False, if no error
Certain endpoints have custom Response
objects that also
implement several helper functions to assist in making use of the response data.
from plasticity import Plasticity
plasticity = Plasticity('<YOUR_TOKEN>')
result = plasticity.sapien.core.post('The Response object contains data and helper methods.')
tpls = result.tpls()
print(tpls) # [[[u'The', u'DT', u'the'], ..., [u'.', u'PERIOD', u'.']]]
Additional documentation for endpoint Response
objects can be found in the
corresponding endpoint file, located in plasticity/<service>/<endpoint>.py
.
If you need help using the library, please contact us at opensource@plasticity.ai.
The main repository for this project can be found on GitLab. The GitHub repository is only a mirror. If you've found a bug in the library or would like new features added, please open issues or pull requests!