geonames search

Recherche de Geonames

Geonames Search est un service de recherche en texte intégral pour le contenu Geonames, conçu pour faciliter la requête des données géographiques via une interface simple et efficace. Construit à l'aide de Python, Flask et OpenSesearch, ce service fournit une infrastructure backend robuste en tirant la recherche d'OpenSearch pour le stockage de données et les capacités de recherche en texte intégral, ainsi que Redis pour la mise en cache.

Remarque : Ceci est un projet de passe-temps.

Caractéristiques

• Recherche de texte intégral : Trouvez rapidement des informations géographiques à l'aide des capacités de recherche en texte intégral d'OpenSearch.
• API REST : Recherchez le contenu Geonames en utilisant le point de terminaison simple /geonames?q=<query> .
• Infrastructure évolutive : construite avec Docker pour s'assurer que le service est facile à déployer et à évoluer.

Commencer

Ces instructions vous procureront une copie du projet opérationnel sur votre machine locale à des fins de développement et de test.

Condition préalable

• Git
• Faire
• Python 3,9 ou plus
• Gestion des paquets de poésie
• Docker et Docker composent

Installation (Docker)

1. Clone le référentiel

git clone https://github.com/m3nin0-labs/geonames-search.git

cd geonames-search

2. Démarrez l'infrastructure

Utilisez la commande make up pour démarrer l'instance OpenSearch, le cache Redis et le service de recherche Geonames.

make up

3. Index Geonames

Pour indexer les données Geonames, vous pouvez utiliser le projet Geonames Index.

Développement

1. Clone le référentiel

git clone https://github.com/m3nin0-labs/geonames-search.git

cd geonames-search

2. Installez les dépendances

Installez toutes les dépendances Python nécessaires à l'aide de la poésie.

poetry install --with dev

3. Exécutez l'application

Démarrez l'application FLASK.

FLASK_APP=geonames_api/main.py flask run

Maintenant, vous êtes prêt à vous développer!

Usage

Pour utiliser le service de recherche Geonames, envoyez simplement une demande GET au point de terminaison avec votre requête de recherche:

 GET /geonames?q=London

Les réponses comprendront des données géographiques appariées de la base de données Geonames.

Contributif

Nous accueillons les contributions! Si vous avez des suggestions d'améliorations ou de corrections de bogues, n'hésitez pas à débourser le référentiel et à soumettre une demande de traction.

Licence

geonames-search est distribué sous la licence MIT. Voir la licence pour plus de détails.