Documentation

README.md

@@ -13,6 +13,18 @@ MyDelivengo (La Poste API documentation) : http://www.assistance-mydelivengo.fr/
 You can find the list of parameters for each function into this
 documentation.
 
+## How to use
+
+```python
+api = PyDelivengo(api_authorization="your_mydelivengo_api_key")
+api.get_user_info()  # Get your user info
+api..get_envois()  # get all your "envois"
+api.get_pli(11437479, print_pdf=True)  # Get the "pli" with ID 11437479 and generate PDF to print
+api.get_depots(params={'date[from]':'30/11/2017'})  # Get the "depots" from November 30th
+```
+
+
+Looks to [MyDelivengo](http://www.assistance-mydelivengo.fr/api/documentation/) documentation to see all parameters.
 
 ## Tools
 

docs/index.html

@@ -1080,6 +1080,14 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
       </div>
       <div class="item">
       <p class="name"><a href="pydelivengo.m.html">pydelivengo.pydelivengo</a></p>
+
+
+
+      </div>
+      <div class="item">
+      <p class="name"><a href="tests/index.html">pydelivengo.tests</a></p>
+
+
 
       </div>
   </section>

docs/pydelivengo.m.html

@@ -1118,6 +1118,16 @@ <h1 class="title"><span class="name">pydelivengo.pydelivengo</span> module</h1>
 
 
 <span class="k">def</span> <span class="nf">add_headers</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Add new headers.</span>
+
+<span class="sd">    :param x: a dict with headers for the API</span>
+<span class="sd">    :type x: dict</span>
+<span class="sd">    :param y: a dict with headers for the API</span>
+<span class="sd">    :type y: dict</span>
+<span class="sd">    :return: a dict with headers merged</span>
+<span class="sd">    :rtype: dict</span>
+<span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">z</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
     <span class="n">z</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">z</span>
@@ -1429,10 +1439,27 @@ <h2 class="section-title" id="header-functions">Functions</h2>
 
 
 
+    <div class="desc"><p>Add new headers.</p>
+<p>:param x: a dict with headers for the API
+:type x: dict
+:param y: a dict with headers for the API
+:type y: dict
+:return: a dict with headers merged
+:rtype: dict</p></div>
   <div class="source_cont">
   <p class="source_link"><a href="javascript:void(0);" onclick="toggle('source-pydelivengo.pydelivengo.add_headers', this);">Show source &equiv;</a></p>
   <div id="source-pydelivengo.pydelivengo.add_headers" class="source">
     <div class="codehilite"><pre><span></span><span class="k">def</span> <span class="nf">add_headers</span><span class="p">(</span><span class="n">x</span><span class="p">,</span> <span class="n">y</span><span class="p">):</span>
+    <span class="sd">&quot;&quot;&quot;</span>
+<span class="sd">    Add new headers.</span>
+
+<span class="sd">    :param x: a dict with headers for the API</span>
+<span class="sd">    :type x: dict</span>
+<span class="sd">    :param y: a dict with headers for the API</span>
+<span class="sd">    :type y: dict</span>
+<span class="sd">    :return: a dict with headers merged</span>
+<span class="sd">    :rtype: dict</span>
+<span class="sd">    &quot;&quot;&quot;</span>
     <span class="n">z</span> <span class="o">=</span> <span class="n">x</span><span class="o">.</span><span class="n">copy</span><span class="p">()</span>
     <span class="n">z</span><span class="o">.</span><span class="n">update</span><span class="p">(</span><span class="n">y</span><span class="p">)</span>
     <span class="k">return</span> <span class="n">z</span>