avalon-searcher

Python 3 Flask application to search Avalon; provides a backend searcher to a Bento Box style search which expects a REST interface following the Quick Search model.

Requires

• Python 3

Running in Docker

$ docker build -t avalon-searcher .
$ docker run -it --rm -p 5000:5000 --env-file=.env --read-only avalon-searcher

Building for Kubernetes

$ docker buildx build . --builder=kube -t docker.lib.umd.edu/avalon-searcher:VERSION --push

Endpoints

This will start the webapp listening on the default port 5000 on localhost (127.0.0.1), and running in Flask's debug mode.

Root endpoint (just returns {status: ok} to all requests): http://localhost:5000/

/ping endpoint (just returns {status: ok} to all requests): http://localhost:5000/ping

/search endpoint: http://localhost:5000/search?q={query}&page={page number?}&per_page={results per page?}

Example:

curl 'http://localhost:5000/search?q=henson&per_page=3&page=0'
{
  "endpoint": "avalon-search",
  "module_link": "https://av.lib.umd.edu/catalog?q=henson&search_field=all_fields&utf8=%E2%9C%93",
  "no_results_link": "https://av.lib.umd.edu/catalog",
  "page": "1",
  "per_page": "3",
  "query": "henson",
  "results": [
    {
      "description": "This special celebrates the life and career of Jim Henson following his death in 1990. The retrospective includes appearances by celebrity guests, a variety of clips from Henson's television and film work, and candid, behind-the-scenes footage of Henson working with his creative team.",
      "extra": {
        "collection": "The Jim Henson Works at the University of Maryland"
      },
      "item_format": "Moving Image",
      "link": "https://av.lib.umd.edu/media_objects/0g354f388",
      "title": "The Muppets celebrate Jim Henson"
    },
    {
      "description": "Documentary television program on the life, work, and success of Jim Henson and his Muppets. Combines clips and interviews with Jim Henson, Jane Henson, Frank Oz, and others to present the story of the Muppets from the early days of public access television to the success of Sesame Street to international phenomenon.",
      "extra": {
        "collection": "The Jim Henson Works at the University of Maryland"
      },
      "item_format": "Moving Image",
      "link": "https://av.lib.umd.edu/media_objects/1831ck18w",
      "title": "Henson's place: the man behind the Muppets"
    },
    {
      "description": "The Storyteller recalls a time when he was unable to think of a story to tell even though his life depended on it.",
      "extra": {
        "collection": "The Jim Henson Works at the University of Maryland"
      },
      "item_format": "Moving Image",
      "link": "https://av.lib.umd.edu/media_objects/v979v3150",
      "title": "Jim Henson’s the storyteller: A story short"
    }
  ],
  "total": 68
}

License

See the LICENSE file for license rights and limitations.