updates for new seeddata service

oduwsdl · May 4, 2019 · 78a098bc0fd48d99c4b123287fa5c6a0a972cc66 · 78a098b
1 parent b09d6cd
commit 78a098bc0fd48d99c4b123287fa5c6a0a972cc66
Unified Split

Showing with 63 additions and 579 deletions.

+1 −0 .dockerignore

+0 −30 Pipfile

+0 −545 Pipfile.lock

+0 −2 README.md

+1 −1 docs/source/conf.py

+60 −0 docs/source/web_api.rst

+1 −1 mementoembed/version.py
diff --git a/.dockerignore b/.dockerignore
@@ -6,3 +6,4 @@ README.md
 Dockerfile
 LICENSE
 node_modules
+  
+docs
diff --git a/Pipfile b/Pipfile
diff --git a/Pipfile.lock b/Pipfile.lock
diff --git a/README.md b/README.md
@@ -98,8 +98,6 @@ The following directory structure exists for organizing MementoEmbed:
 * Dockerfile - used to build the docker image
 * LICENSE - the license for this project
 * MANIFEST.in - used to ensure additional files are installed on the system when pip is run
-  
-* Pipfile - package information used by pipenv
-  
-* Pipfile.lock - package version information used by pipenv
 * README.md - this file
 * dockerstart.sh - the script run by Docker to start MementoEmbed once a container is started
 * package-lock.json - pakcage version information used by npm

diff --git a/docs/source/conf.py b/docs/source/conf.py
@@ -26,7 +26,7 @@
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-  
-release = '0.2019.02.12.201118'
+  
+release = '0.2019.05.04.154314'
 # -- General configuration ---------------------------------------------------

diff --git a/docs/source/web_api.rst b/docs/source/web_api.rst
@@ -100,6 +100,66 @@ On success, this service produces an HTTP response with a MIME-type of ``applica
        "original-linkstatus": "Live"
    }
+  
+Seed data
+  
+~~~~~~~~~
+  
+
+  
+Endpoint: ``/services/memento/seeddata/<URI-M>``
+  
+
+  
+On success, this service produces an HTTP response with a MIME-type of ``application-json`` that contains information about the seed::
+  
+
+  
+    {
+  
+        "urim": "https://www.webarchive.org.uk/wayback/archive/20090522221251/http://blasttheory.co.uk/",
+  
+        "seeduri": "http://blasttheory.co.uk/",
+  
+        "mementocount": 80,
+  
+        "first-mdt": "2009-05-22T22:12:30Z",
+  
+        "last-mdt": "2009-05-22T22:12:30Z",
+  
+        "metadata": {}
+  
+    }
+  
+
+  
+Web archives often contain the first and last memento-datetime in the Memento headers, but not all do. This service finds the other mementos available at the archive and creates the first and last entries for you.
+  
+
+  
+For Archive-It mementos, the ``application-json`` contains the metadata supplied by the collection curator for this seed::
+  
+
+  
+    {
+  
+        "urim": "https://wayback.archive-it.org/2358/20111121082744/http://twitter.com/CarlosLatuff/",
+  
+        "seeduri": "http://twitter.com/CarlosLatuff/",
+  
+        "mementocount": 204,
+  
+        "first-mdt": "2011-11-21T08:27:44Z",
+  
+        "last-mdt": "2014-12-04T14:01:33Z",
+  
+        "metadata": [
+  
+            {
+  
+                "title": "Carlos Latuff on Twitter",
+  
+                "videos": [
+  
+                    "21 Videos Captured"
+  
+                ],
+  
+                "subject": [
+  
+                    "Revolutions--Egypt",
+  
+                    "Social media--Political aspects"
+  
+                ],
+  
+                "language": [
+  
+                    "en"
+  
+                ],
+  
+                "format": [
+  
+                    "Web sites"
+  
+                ],
+  
+                "type": [
+  
+                    "Interactive Resource",
+  
+                    "Interactive Resource"
+  
+                ],
+  
+                "relation": [
+  
+                    "January 25th Revolution Web sites"
+  
+                ],
+  
+                "collector": [
+  
+                    "American University in Cairo. Rare Books and Special Collections Library",
+  
+                    "American University in Cairo. Rare Books and Special Collections Library"
+  
+                ]
+  
+            }
+  
+        ]
+  
+    }
+  
+
+  
+
+  
+Note that the ``metadata`` key is a list. Sometimes an Archive-It collection contains the same seed multiple times. Each instance of the same seed will be a separate list entry in value for the ``metadata`` key.
+  
+
 Product Endpoints for Requesting a Surrogate Directly
 -----------------------------------------------------

diff --git a/mementoembed/version.py b/mementoembed/version.py
@@ -1,3 +1,3 @@
 __appname__ = "MementoEmbed"
-  
-__appversion__ = '0.2019.02.12.201118'
+  
+__appversion__ = '0.2019.05.04.154314'
 __useragent__ = "{}/{}".format(__appname__, __appversion__)