diff --git a/README.md b/README.md index 1642fb6..9a64a50 100644 --- a/README.md +++ b/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') ``` diff --git a/api.ipynb b/api.ipynb index 7c0c1c7..6567ae2 100644 --- a/api.ipynb +++ b/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": {}, diff --git a/docs/api.html b/docs/api.html index 9368fe7..f727a1e 100644 --- a/docs/api.html +++ b/docs/api.html @@ -57,6 +57,30 @@

class OmekaAPIClie
+
+ {% endraw %} + +
+
+

First import the OmekaAPIClient class.

+ +
+
+
+ {% raw %} + +
+
+ +
+
+
from omeka_s_tools.api import OmekaAPIClient
+
+ +
+
+
+
{% endraw %} diff --git a/docs/index.html b/docs/index.html index ec1d71d..77b661a 100644 --- a/docs/index.html +++ b/docs/index.html @@ -56,7 +56,9 @@

How to use
-
omeka = OmekaAPIClient('http://timsherratt.org/collections/api')
+
from omeka_s_tools.api import OmekaAPIClient
+
+omeka = OmekaAPIClient('http://timsherratt.org/collections/api')
 
diff --git a/index.ipynb b/index.ipynb index 227b5c9..fd87445 100644 --- a/index.ipynb +++ b/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')" ] }, diff --git a/omeka_s_tools/__init__.py b/omeka_s_tools/__init__.py index 3b93d0b..27fdca4 100644 --- a/omeka_s_tools/__init__.py +++ b/omeka_s_tools/__init__.py @@ -1 +1 @@ -__version__ = "0.0.2" +__version__ = "0.0.3" diff --git a/settings.ini b/settings.ini index 90b1f78..8b163ef 100644 --- a/settings.ini +++ b/settings.ini @@ -13,7 +13,7 @@ author = Tim Sherratt author_email = tim@timsherratt.org copyright = Tim Sherratt branch = master -version = 0.0.2 +version = 0.0.3 min_python = 3.6 audience = Developers language = English