Skip to content

Commit ef62937

Browse files
committed
Add Readme.md
1 parent 1cab98d commit ef62937

1 file changed

Lines changed: 56 additions & 0 deletions

File tree

README.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
.. _ref-tutorial:
2+
3+
====================================
4+
Getting Started with Priority Matrix
5+
====================================
6+
7+
8+
Requirements
9+
============
10+
Install dependencies:
11+
The API request processor library - `Slumber`_ ::
12+
13+
$ pip install slumber
14+
15+
.. _Slumber: http://slumber.readthedocs.org/en/v0.6.0/
16+
17+
The encoder and decoder Json library - `Demjson`_ ::
18+
19+
$ pip install demjson
20+
21+
.. _Demjson: https://pypi.python.org/pypi/demjson
22+
23+
24+
Installation
25+
============
26+
27+
There are two ways to install the extension.
28+
Using pip::
29+
30+
$ pip install priority_matrix
31+
32+
or download the package, and from the source tree::
33+
34+
$ [sudo] python setup.py install
35+
36+
Authentication and quick use
37+
===============
38+
39+
1. Priority Matrix API uses a the authentication OAuth 2.0.
40+
41+
You need an access token to use the library.
42+
43+
Please, follow the instructions of this tutorial to get the access token.
44+
45+
2. Printing an item.
46+
47+
test::
48+
49+
import priority_matrix
50+
51+
pm = PM("https://sync.appfluence.com/api/v1/", "your_access_token")
52+
53+
print pm.project("project_name").item("item_name").toString()
54+
pm.project("project_name").item("item_name").name = "New item name"
55+
print pm.project("project_name").item("item_name").name
56+
print pm.project("project_name").item("item_name").id

0 commit comments

Comments
 (0)