canonicalwebteam.search

CanonicalWebTeam.search

Extensão de frasco para fornecer uma visualização de pesquisa para consultar a conta de pesquisa personalizada do Google do WebTeam.

Instalação

pip3 install canonicalwebteam.search

Ou adicione canonicalwebteam.search aos seus requirements.txt .

Uso

Requisitos

Se você estiver usando a base de frasco, precisará usar pelo menos 2.0.0. Caso contrário, precisará pelo menos [email protected].

Desenvolvimento local

Para o desenvolvimento local, é melhor testar este módulo com um de nossos projetos de site como o Ubuntu.com. Para mais informações, siga este guia (somente interno).

Código do aplicativo

Você pode adicionar a extensão no aplicativo do seu projeto da seguinte forma:

 import talisker . requests
from flask import Flask
from canonicalwebteam . search import build_search_view

app = Flask ( "myapp" ) # You must provide app
session = talisker . requests . get_session ()  # You must provide a requests session

app . add_url_rule ( "/search" , "search" , build_search_view ( app , session ))

# Or, a bit more complex example

app . add_url_rule (
    "/docs/search" ,
    "docs-search" ,
    build_search_view (
        app = app # required in version 1.4.0 onwards
        session = session ,
        site = "maas.io/docs" ,
        template_path = "docs/search.html" ,
        search_engine_id = "xxxxxxxxxx" , # Optional argument, required by some of our sites
        request_limit = "500/day" , # Allows your to configure the limit at which the user will be forbidden to query more. If omitted defaults to 2/second, 100/minute, 2000/day
    )
)

O modelo

Você precisa criar um modelo HTML no template_path específico_Path. Por padrão, isso será search.html dentro da pasta Modelos. Este modelo será passado os seguintes dados:

• {{ query }} - o conteúdo do parâmetro q= Search Query
• {{ start }} - o conteúdo do parâmetro start= consulta - o deslocamento para começar a retornar os resultados (usados ​​para paginação - padrão 0)
• {{ num }} - o conteúdo do parâmetro num= consulta - o número de resultados de pesquisa para retornar (padrão 10)
• {{ results }} - Os resultados retornados da consulta de pesquisa personalizada do Google. Os resultados da pesquisa reais estão em {{ results.entries }} .

A chave da API

Você precisa fornecer a chave da API para a API de pesquisa personalizada do Google como uma variável de ambiente chamada SEARCH_API_KEY quando o servidor é iniciado - por exemplo:

 SEARCH_API_KEY=xxxxx FLASK_APP=app.py flask run

Quando isso for feito, você poderá visitar /search?q={some_query} em seu site e consulte os resultados da pesquisa criados com o seu modelo search.html .

Para alguns sites, você precisará passar um ID de mecanismo de pesquisa específico (CX) para o build_search_view , que encontrará na página do mecanismo de pesquisa personalizado.

Novos sites

Se você criou um novo site e a API não está retornando nenhum resultado, pode ser necessário adicioná -lo à lista de sites de mecanismos de pesquisa personalizada do Google. Se você não vir nenhum site nesta página, pergunte ao WebTeam.