Skip to content

Latest commit

 

History

History
152 lines (100 loc) · 4.52 KB

README.md

File metadata and controls

152 lines (100 loc) · 4.52 KB
Raw

PIX Python API

Build Status

A python api for interacting with PIX. It's goal is to provide a more pythonic and object-oriented experience when interacting with PIX's existing REST API. It provides a simple ways to custom objects returned from PIX that are specific for your needs.

overview

Quick Start

Install from pypi:
pip install pix-api

OR

Install from source:
git clone https://github.com/sambvfx/pix.git
cd pix
pip install .

Basics

Starting a Session

Interacting with PIX requires a Session object. This is the object that manages all the API calls to PIX's REST endpoints.

import pix


session = pix.Session(
    api_url='https://project.pixsystem.com/developer/api/2',
    app_key='123abc',
    username='sambvfx',
    password='mypassword',
    plugin_paths='/path/to/mypixmodels.py:/path/to/other/package',
)

The Session arguments can also use defaults from the environment.

$ export PIX_API_URL='https://project.pixsystem.com/developer/api/2'
$ export PIX_APP_KEY='123abc'
$ export PIX_USERNAME='sambvfx'
$ export PIX_PASSWORD='mypassword'
$ export PIX_PLUGIN_PATH='/path/to/mypixmodels.py:/path/to/other/package'

Loading a Project

Once we have a session, before we issue any API calls a project needs to be activated. Returned results will change depending on the active project.

import pix


session = pix.Session()
projects = session.get_projects()
print(projects)
# [<PIXProject('MyProject')>]
project = session.load_project('MyProject')

Fetching Data

The internals of pix are driven by a class factory that dynamically builds classes from the json data returned from the REST endpoints. The factory recursively turns any viable data structures within the json data into a PIXObject. The objects created by the factory are dictionary-like objects where data returned by the servers can be accessed like a dictionary (e.g. obj['key']).

There's a handful of provided models that the dynamic objects will be built from. These provide some general helper methods.

import pix


session = pix.Session()
session.login()

project = session.load_project('MyProject')

# print unread inbox messages
for feed in project.get_inbox():
    # Skip stuff we've already marked as viewed.
    if not feed['viewed']:
        print('{!r} -> {!r} : {!r}'.format(
            feed.sender, feed.recipients, feed.message))

session.logout()

Extending

The provided models have some standard helpful methods on them but it's possible to further customize. You can inject your own custom behaviors onto the dynamically created PIX objects. These can exist in your own code repository and can be added to the factory via the environment variable PIX_PLUGIN_PATH.

# mypixmodels.py

import pix


@pix.register('PIXNote')
class MyPIXNote:

    def ingest(self):
        print('Ingesting note!')

As long as the PIX_PLUGIN_PATH has mypixmodels.py available the returned PIXNote objects will have the custom ingest method on them.

import pix


with pix.Session() as session:
    project = session.load_project('MyProject')
    for feed in project.get_inbox():
        for attachment in feed.get_attachments():
            for note in attachment.get_notes():
                note.ingest()

Examples

Check out some examples to get started.

NOTE: Some examples may require thirdparty libraries or other things to be installed to work properly. Check out the example's documentation for further instructions.

Contributing

Providing more examples is a wonderful way to showcase how to use pix. If you have something you think others would find useful we'd love to hear from you!

If you wish to contribute code back please install the tests dependencies using the tests bundle to ensure you have the required packages to run the tests.

pip install -e ".[tests]"

The tests can by ran simply with pytest. Use tox to ensure continued support of multiple versions of python.