{"id":24093237,"url":"https://github.com/umd-lib/website-searcher","last_synced_at":"2025-08-01T08:15:24.810Z","repository":{"id":40536294,"uuid":"459293588","full_name":"umd-lib/website-searcher","owner":"umd-lib","description":"Libraries' Website Searcher","archived":false,"fork":false,"pushed_at":"2022-12-16T18:15:18.000Z","size":20,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":12,"default_branch":"main","last_synced_at":"2025-01-10T09:26:02.809Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/umd-lib.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2022-02-14T19:15:21.000Z","updated_at":"2022-02-14T19:19:40.000Z","dependencies_parsed_at":"2023-01-29T15:45:15.581Z","dependency_job_id":null,"html_url":"https://github.com/umd-lib/website-searcher","commit_stats":null,"previous_names":[],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Fwebsite-searcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Fwebsite-searcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Fwebsite-searcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Fwebsite-searcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umd-lib","download_url":"https://codeload.github.com/umd-lib/website-searcher/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241005359,"owners_count":19892779,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-01-10T09:26:19.144Z","updated_at":"2025-02-27T10:47:41.117Z","avatar_url":"https://github.com/umd-lib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# website-searcher\n\nPython 3 Flask application to search the Libraries' website; provides a backend searcher to a Bento Box style search\nwhich expects a REST interface following the Quick Search model.\n\n## Requires\n\n* Python 3.10.8\n\n### Development Setup\n\nSee [docs/DevelopmentSetup.md](docs/DevelopmentSetup.md).\n\n### Running in Docker\n\n```bash\n$ docker build -t website-searcher .\n$ docker run -it --rm -p 5000:5000 --env-file=.env --read-only website-searcher\n```\n\n### Building for Kubernetes\n\n```bash\n$ docker buildx build . --builder=kube -t docker.lib.umd.edu/website-searcher:VERSION --push\n```\n\n### Endpoints\n\nThis will start the webapp listening on the default port 5000 on localhost\n(127.0.0.1), and running in [Flask's debug mode].\n\nRoot endpoint (just returns `{status: ok}` to all requests):\n\u003chttp://localhost:5000/\u003e\n\n/ping endpoint (just returns `{status: ok}` to all requests):\n\u003chttp://localhost:5000/ping\u003e\n\n/search endpoint: `http://localhost:5000/search?q={query}\u0026page={page number?}\u0026per_page={results per page?}`\n\nExample:\n\n```bash\ncurl 'http://localhost:5000/search?q=jstor\u0026per_page=3\u0026page=0'\n{\n  \"endpoint\": \"website-search\",\n  \"module_link\": \"https://search.lib.umd.edu/website?query=jstor\",\n  \"no_results_link\": \"https://search.lib.umd.edu/website\",\n  \"page\": \"0\",\n  \"per_page\": \"3\",\n  \"query\": \"jstor\",\n  \"results\": [\n    {\n      \"description\": \"Sep 14, 2017 ... JSTOR Retention Policy | JSTOR is an electronic archive of core journals in the humanities, social sciences, and sciences.\",\n      \"extra\": {\n        \"displayLink\": \"www.lib.umd.edu\",\n        \"htmlSnippet\": \"Sep 14, 2017 \u003cb\u003e...\u003c/b\u003e \u003cb\u003eJSTOR\u003c/b\u003e Retention Policy | \u003cb\u003eJSTOR\u003c/b\u003e is an electronic archive of core journals in the humanities, social sciences, and sciences.\",\n        \"snippet\": \"Sep 14, 2017 ... JSTOR Retention Policy | JSTOR is an electronic archive of core journals in the humanities, social sciences, and sciences.\"\n      },\n      \"item_format\": \"web_page\",\n      \"link\": \"https://www.lib.umd.edu/collections/policies/jstor-retention-policy\",\n      \"title\": \"JSTOR Retention Policy - Collections\"\n    },\n    {\n      \"description\": \"As the largest university library system in the Washington D.C.-Baltimore area, the University Libraries serve 37000 students and faculty of the flagship ...\",\n      \"extra\": {\n        \"displayLink\": \"www.lib.umd.edu\",\n        \"htmlSnippet\": \"As the largest university library system in the Washington D.C.-Baltimore area, the University Libraries serve 37000 students and faculty of the flagship\u0026nbsp;...\",\n        \"snippet\": \"As the largest university library system in the Washington D.C.-Baltimore area, the University Libraries serve 37000 students and faculty of the flagship ...\"\n      },\n      \"item_format\": \"web_page\",\n      \"link\": \"https://www.lib.umd.edu/\",\n      \"title\": \"University of Maryland Libraries\"\n    },\n    {\n      \"description\": \"Oct 7, 2021 ... Remote access to library resources is available for all current University of Maryland, College Park students, faculty, and staff. Database ...\",\n      \"extra\": {\n        \"displayLink\": \"www.lib.umd.edu\",\n        \"htmlSnippet\": \"Oct 7, 2021 \u003cb\u003e...\u003c/b\u003e Remote access to library resources is available for all current University of Maryland, College Park students, faculty, and staff. Database\u0026nbsp;...\",\n        \"snippet\": \"Oct 7, 2021 ... Remote access to library resources is available for all current University of Maryland, College Park students, faculty, and staff. Database ...\"\n      },\n      \"item_format\": \"web_page\",\n      \"link\": \"https://www.lib.umd.edu/services/remote-access\",\n      \"title\": \"How do I Connect to Electronic Resources Off-Campus? | UMD ...\"\n    }\n  ],\n  \"total\": 854\n}\n\n```\n\n[Flask's debug mode]: https://flask.palletsprojects.com/en/2.2.x/cli/?highlight=debug%20mode\n\n## License\n\nSee the [LICENSE](LICENSE.txt) file for license rights and limitations.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumd-lib%2Fwebsite-searcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumd-lib%2Fwebsite-searcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumd-lib%2Fwebsite-searcher/lists"}