Flask extension to provide a search view for querying the webteam's Google Custom Search account
Project description
canonicalwebteam.search
Flask extension to provide a search view for querying the webteam's Google Custom Search account.
Installation
pip3 install canonicalwebteam.search
Or add canonicalwebteam.search to your requirements.txt.
Usage
Application code
You can add the extension on your project's application as follows:
import talisker.requests
from flask import Flask
from canonicalwebteam.search import build_search_view
app = Flask("myapp")
session = talisker.requests.get_session() # You must provide a requests session
app.add_url_rule("/search", "search", build_search_view(session))
# Or, a bit more complex example
app.add_url_rule(
"/docs/search",
"docs-search",
build_search_view(
session=session,
site="maas.io/docs",
template_path="docs/search.html"
search_engine_id="xxxxxxxxxx" # Optional argument, required by some of our sites
)
)
The template
You need to create an HTML template at the specificed template_path. By default this will be search.html inside your templates folder. This template will be passed the following data:
{{ query }}- the contents of theq=search query parameter{{ start }}- the contents of thestart=query parameter - the offset at which to start returning results (used for pagination - default 0){{ num }}- the contents of thenum=query parameter - the number of search results to return (default 10){{ results }}- the results returned from the Google Custom Search query. The actual search results are in{{ results.entries }}.
The API key
You then need to provide the API key for the Google Custom Search API as an environment variable called SEARCH_API_KEY when the server starts - e.g.:
SEARCH_API_KEY=xxxxx FLASK_APP=app.py flask run
Once this is done, you should be able to visit /search?q={some_query} in your site and see search results built with your search.html template.
For some sites, you will need to pass a specific search engine ID (cx) to the build_search_view which you will find in the Custom Search Engine page.
New sites
If you created a new site and the API is not returning any results, you may need to add it to the Google Custom Search Engine list of sites. If you don't see any sites in this page, ask the Webteam.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file canonicalwebteam.search-1.1.0.tar.gz.
File metadata
- Download URL: canonicalwebteam.search-1.1.0.tar.gz
- Upload date:
- Size: 10.2 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.2 importlib_metadata/4.0.1 pkginfo/1.4.2 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 8238fa0aacae0ffb5627457465e1a023b4025c7dd00d54d91d57bd15c693a858 |
|
| MD5 | 8ba40c6b09dcd725d0b213d186d6c145 |
|
| BLAKE2b-256 | 703856e1cde80009ce6c9c6cab22190eb4d97a95f916e6c6c1c390b984bc3302 |
