.. _ref-tutorial:

====================================
Getting Started with Priority Matrix
====================================


Requirements
============
Install dependencies:
The API request processor library - `Slumber`_ ::

  $ pip install slumber

..  _Slumber: http://slumber.readthedocs.org/en/v0.6.0/

The encoder and decoder Json library - `Demjson`_ ::

  $ pip install demjson

.. _Demjson: https://pypi.python.org/pypi/demjson


Installation
============

There are two ways to install the extension.
Using pip::

  $ pip install priority_matrix

or download the package, and from the source tree::

  $ [sudo] python setup.py install

Authentication and quick use
===============

1. Priority Matrix API uses a the authentication  OAuth 2.0.

   You need an access token to use the library.

   Please, follow the instructions of this tutorial to get the access token.

2. Printing an item.

   test.py::

     import priority_matrix

     pm = PM("https://sync.appfluence.com/api/v1/", "your_access_token")

     print pm.project("project_name").item("item_name").toString()
     pm.project("project_name").item("item_name").name = "New item name"
     print pm.project("project_name").item("item_name").name
     print pm.project("project_name").item("item_name").id