Show imports in docs

README.md

@@ -11,6 +11,8 @@
 [See the documentation](https://wragge.github.io/omeka_s_tools/api.html) for full details of the Omeka API Client.
 
 ```python
+from omeka_s_tools.api import OmekaAPIClient
+
 omeka = OmekaAPIClient('http://timsherratt.org/collections/api')
 ```
 

api.ipynb

@@ -445,6 +445,22 @@
     "        return files"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "First import the `OmekaAPIClient` class."
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "from omeka_s_tools.api import OmekaAPIClient"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

docs/api.html

@@ -57,6 +57,30 @@ <h2 id="OmekaAPIClient" class="doc_header"><code>class</code> <code>OmekaAPIClie
 
 <div class="cell border-box-sizing code_cell rendered">
 
+</div>
+    {% endraw %}
+
+<div class="cell border-box-sizing text_cell rendered"><div class="inner_cell">
+<div class="text_cell_render border-box-sizing rendered_html">
+<p>First import the <a href="/omeka_s_tools/api.html#OmekaAPIClient"><code>OmekaAPIClient</code></a> class.</p>
+
+</div>
+</div>
+</div>
+    {% raw %}
+
+<div class="cell border-box-sizing code_cell rendered">
+<div class="input">
+
+<div class="inner_cell">
+    <div class="input_area">
+<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">omeka_s_tools.api</span> <span class="kn">import</span> <span class="n">OmekaAPIClient</span>
+</pre></div>
+
+    </div>
+</div>
+</div>
+
 </div>
     {% endraw %}
 

docs/index.html

@@ -56,7 +56,9 @@ <h2 id="How-to-use">How to use<a class="anchor-link" href="#How-to-use"> </a></h
 
 <div class="inner_cell">
     <div class="input_area">
-<div class=" highlight hl-ipython3"><pre><span></span><span class="n">omeka</span> <span class="o">=</span> <span class="n">OmekaAPIClient</span><span class="p">(</span><span class="s1">&#39;http://timsherratt.org/collections/api&#39;</span><span class="p">)</span>
+<div class=" highlight hl-ipython3"><pre><span></span><span class="kn">from</span> <span class="nn">omeka_s_tools.api</span> <span class="kn">import</span> <span class="n">OmekaAPIClient</span>
+
+<span class="n">omeka</span> <span class="o">=</span> <span class="n">OmekaAPIClient</span><span class="p">(</span><span class="s1">&#39;http://timsherratt.org/collections/api&#39;</span><span class="p">)</span>
 </pre></div>
 
     </div>

index.ipynb

@@ -48,6 +48,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
+    "from omeka_s_tools.api import OmekaAPIClient\n",
+    "\n",
     "omeka = OmekaAPIClient('http://timsherratt.org/collections/api')"
    ]
   },

omeka_s_tools/__init__.py

@@ -1 +1 @@
-__version__ = "0.0.2"
+__version__ = "0.0.3"

settings.ini

@@ -13,7 +13,7 @@ author = Tim Sherratt
 author_email = [email protected]
 copyright = Tim Sherratt
 branch = master
-version = 0.0.2
+version = 0.0.3
 min_python = 3.6
 audience = Developers
 language = English