Merge branch 'Samuc-master'

Author: ihaveajob

README.md

@@ -1,22 +1,54 @@
-# Priority Matrix Python API
-#Requirements
+====================================
+Getting Started with Priority Matrix
+====================================
 
-Priority Matrix requires the following modules:
- - Python 2.5+
- - Slumber
- - Demjson
- - Quick view of PM use
 
-PM is easy to use to interact with the API:
-test.py:
+Requirements
+============
+Install dependencies:
+The API request processor library [Slumber](http://slumber.readthedocs.org/en/v0.6.0/) :
+
+  `$ pip install slumber`
+
+
+The encoder and decoder Json library [Demjson](https://pypi.python.org/pypi/demjson) :
+
+ `$ pip install 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 and modifying an item.
+
+   test:
 
 ```
-import priority_matrix
+     import priority_matrix
 
-pm = PM("https://sync.appfluence.com/api/v1/", "your_access_token")
+     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
+     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
 ```

html_sphinx/_build/_sources/tutorial.txt

@@ -23,10 +23,15 @@ The encoder and decoder Json library - `Demjson`_ ::
 
 Installation
 ============
-Download the package, and from the source tree::
 
-  $ [sudo] python setup.py install
+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
 ===============

html_sphinx/_build/doctrees/code_documentation.doctree

@@ -34,6 +34,9 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              accesskey="I">index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li class="right" >
           <a href="get_access_token.html" title="Getting Access Token Authentication - OAuth 2.0"
              accesskey="N">next</a> |</li>
@@ -65,7 +68,12 @@ <h2>Requirements<a class="headerlink" href="#requirements" title="Permalink to t
 </div>
 <div class="section" id="installation">
 <h2>Installation<a class="headerlink" href="#installation" title="Permalink to this headline">¶</a></h2>
-<p>Download the package, and from the source tree:</p>
+<p>There are two ways to install the extension.
+Using pip:</p>
+<div class="highlight-default"><div class="highlight"><pre><span></span>$ pip install priority_matrix
+</pre></div>
+</div>
+<p>or download the package, and from the source tree:</p>
 <div class="highlight-default"><div class="highlight"><pre><span></span>$ [sudo] python setup.py install
 </pre></div>
 </div>
@@ -145,6 +153,9 @@ <h3>Navigation</h3>
         <li class="right" style="margin-right: 10px">
           <a href="genindex.html" title="General Index"
              >index</a></li>
+        <li class="right" >
+          <a href="py-modindex.html" title="Python Module Index"
+             >modules</a> |</li>
         <li class="right" >
           <a href="get_access_token.html" title="Getting Access Token Authentication - OAuth 2.0"
              >next</a> |</li>

html_sphinx/_build/doctrees/environment.pickle

@@ -23,10 +23,15 @@ The encoder and decoder Json library - `Demjson`_ ::
 
 Installation
 ============
-Download the package, and from the source tree::
 
-  $ [sudo] python setup.py install
+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
 ===============

html_sphinx/_build/doctrees/tutorial.doctree

@@ -3,10 +3,10 @@
 setup(name='prioritymatrix',
       version='0.1',
       description='Priority Matrix API',
-      url='https://appfluence.com',
       author='Samuel Carmona',
+      url = 'https://github.com/samuc/prioritymatrix-python',
+      download_url = 'https://github.com/samuc/prioritymatrix-python/tarball/0.1',
       author_email='samuel@appfluence.com',
       license='MIT',
       packages=['prioritymatrix'],
       zip_safe=False)
-