{"id":24093280,"url":"https://github.com/umd-lib/faq-searcher","last_synced_at":"2026-06-08T01:32:42.454Z","repository":{"id":147002673,"uuid":"573154536","full_name":"umd-lib/faq-searcher","owner":"umd-lib","description":null,"archived":false,"fork":false,"pushed_at":"2023-01-18T17:52:35.000Z","size":12,"stargazers_count":0,"open_issues_count":0,"forks_count":1,"subscribers_count":5,"default_branch":"main","last_synced_at":"2025-02-27T12:42:11.437Z","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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-12-01T20:20:19.000Z","updated_at":"2022-12-01T20:22:25.000Z","dependencies_parsed_at":"2023-04-04T20:06:24.074Z","dependency_job_id":null,"html_url":"https://github.com/umd-lib/faq-searcher","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"purl":"pkg:github/umd-lib/faq-searcher","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Ffaq-searcher","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Ffaq-searcher/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Ffaq-searcher/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Ffaq-searcher/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/umd-lib","download_url":"https://codeload.github.com/umd-lib/faq-searcher/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/umd-lib%2Ffaq-searcher/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":34044919,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-05-26T15:22:16.424Z","status":"online","status_checked_at":"2026-06-07T02:00:07.652Z","response_time":124,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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:27:02.418Z","updated_at":"2026-06-08T01:32:42.449Z","avatar_url":"https://github.com/umd-lib.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# faq-searcher\n\nPython 3 Flask application to search the libanswers FAQ searcher.\n\n## Requires\n\n* Python 3.10.8\n\n### Development Setup\n\nSee [docs/DevelopmentSetup.md](docs/DevelopmentSetup.md).\n\n## Environment Configuration\n\nThe application requires a \".env\" file in the root directory to provide\nserver-specific information (i.e., those parts of the configuration that\nmay vary based on whether the server is a test/qa/production server).\n\nA sample \"env_example\" file has been provided to assist with this process.\nSimply copy the \"env_example\" file to \".env\" and fill out the parameters as\nappropriate.\n\nThe configured .env file should not be checked into the Git repository.\n\n### Running in Docker\n\n```bash\n$ docker build -t docker.lib.umd.edu/faq-searcher .\n$ docker run -it --rm -p 5000:5000 --env-file=.env --read-only docker.lib.umd.edu/faq-searcher\n```\n\n### Building for Kubernetes\n\n```bash\n$ docker buildx build . --builder=kube -t docker.lib.umd.edu/faq-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:\n\n```bash\nhttp://localhost:5000/search?q=print\u0026per_page=3\u0026page=0\n```\n\nExample:\n\n```bash\ncurl 'http://localhost:5000/search?q=print\u0026per_page=3\u0026page=0'\n{\n  \"endpoint\": \"faq\",\n  \"module_link\": \"http://umd.libanswers.com/search?q=print\",\n  \"page\": 0,\n  \"per_page\": 3,\n  \"query\": \"print\",\n  \"results\": [\n    {\n      \"description\": \"Photocopying, Printing, Library 101\",\n      \"item_format\": \"web_page\",\n      \"link\": \"https://umd.libanswers.com/faq/66289\",\n      \"title\": \"How do I print?\"\n    },\n    {\n      \"description\": \"Printing, Makerspace\",\n      \"item_format\": \"web_page\",\n      \"link\": \"https://umd.libanswers.com/faq/66460\",\n      \"title\": \"Can I 3D Print in two different colors?\"\n    },\n    {\n      \"description\": \"Photocopying, Printing, Library 101\",\n      \"item_format\": \"web_page\",\n      \"link\": \"https://umd.libanswers.com/faq/66032\",\n      \"title\": \"How can I print and/or make copies?\"\n    }\n  ],\n  \"total\": 42\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%2Ffaq-searcher","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fumd-lib%2Ffaq-searcher","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fumd-lib%2Ffaq-searcher/lists"}