Flask扩展,提供用于查询WebTeam的Google自定义搜索帐户的搜索视图
canonicalwebteam.search的Python项目详细描述
canonicalwebteam.search
Flask扩展,提供用于查询WebTeam的Google自定义搜索帐户的搜索视图。
安装
pip3 install canonicalwebteam.search
或者将canonicalwebteam.search
添加到requirements.txt
中。
用法
应用程序代码
您可以在项目的应用程序中添加扩展,如下所示:
fromcanonicalwebteam.searchimportbuild_search_viewapp=Flask("myapp")app.add_url_rule("/search","search",build_search_view())# Or, a bit more complex exampleapp.add_url_rule("/docs/search","docs-search",build_search_view(site="maas.io/docs",template_path="docs/search.html"))
模板
您需要在指定的template_path
创建一个html模板。默认情况下,这将是模板文件夹中的search.html
。此模板将传递以下数据:
{{ query }}
-搜索查询参数q=
的内容{{ start }}
-查询参数start=
的内容-开始返回结果的偏移量(用于分页-默认值0){{ num }}
-查询参数num=
的内容-要返回的搜索结果数(默认值10){{ results }}
-从google自定义搜索查询返回的结果。实际搜索结果位于{{ results.entries }}
。
api键
然后,您需要在服务器启动时将google自定义搜索api的api键作为名为SEARCH_API_KEY
的环境变量提供,例如:
SEARCH_API_KEY=xxxxx FLASK_APP=app.py flask run
完成后,您应该能够访问站点中的/search?q={some_query}
,并查看使用search.html
模板生成的搜索结果。