canonicalwebteam.search

CanonicalWebTeam.Search

Flask Extension untuk memberikan tampilan pencarian untuk meminta akun pencarian kustom Google WebTeam.

Instalasi

pip3 install canonicalwebteam.search

Atau tambahkan canonicalwebteam.search ke requirements.txt Anda.txt.

Penggunaan

Persyaratan

Jika Anda menggunakan flask-base, Anda harus menggunakan setidaknya 2.0.0. Jika tidak, Anda akan membutuhkan minimal [email protected].

Pengembangan Lokal

Untuk pengembangan lokal, yang terbaik adalah menguji modul ini dengan salah satu proyek situs web kami seperti ubuntu.com. Untuk informasi lebih lanjut, ikuti panduan ini (hanya internal).

Kode aplikasi

Anda dapat menambahkan ekstensi pada aplikasi proyek Anda sebagai berikut:

 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
    )
)

Template

Anda perlu membuat template HTML di template_path yang spesifik. Secara default ini akan menjadi search.html di dalam folder template Anda. Template ini akan diloloskan data berikut:

• {{ query }} - Isi Parameter Query q=
• {{ start }} - Isi dari parameter start= kueri - offset untuk mulai mengembalikan hasil (digunakan untuk pagination - default 0)
• {{ num }} - Isi dari parameter num= kueri - jumlah hasil pencarian yang akan dikembalikan (default 10)
• {{ results }} - Hasil yang dikembalikan dari kueri pencarian kustom Google. Hasil pencarian yang sebenarnya ada di {{ results.entries }} .

Kunci API

Anda kemudian perlu menyediakan kunci API untuk Google Custom Search API sebagai variabel lingkungan yang disebut SEARCH_API_KEY saat server dimulai - misalnya:

 SEARCH_API_KEY=xxxxx FLASK_APP=app.py flask run

Setelah ini selesai, Anda harus dapat mengunjungi /search?q={some_query} di situs Anda dan melihat hasil pencarian yang dibangun dengan Templat search.html Anda.

Untuk beberapa situs, Anda harus melewati ID Mesin Pencari tertentu (CX) ke build_search_view yang akan Anda temukan di halaman mesin pencari khusus.

Situs baru

Jika Anda membuat situs baru dan API tidak mengembalikan hasil apa pun, Anda mungkin perlu menambahkannya ke daftar mesin pencari kustom Google. Jika Anda tidak melihat situs apa pun di halaman ini, tanyakan pada webteam.