geonames search

Geonames -Suche

Geonames Search ist ein Volltext-Suchdienst für Geonames-Inhalte, der die Abfrage geografischer Daten über eine einfache und effiziente Schnittstelle erleichtert. Dieser Dienst wurde mit Python, Flask und OpenSearch erstellt und bietet eine robuste Backend-Infrastruktur, die OpenSearch für Datenspeicher und Volltext-Suchfunktionen sowie Redis für das Caching zur Verfügung stellt.

Hinweis : Dies ist ein Hobbyprojekt.

Merkmale

• Volltext-Suche : Finden Sie schnell geografische Informationen unter Verwendung der Volltext-Suchfunktionen von OpenSearch.
• REST -API : Durchsuchen Sie den Inhalt des Geonames mit dem einfachen Endpunkt /geonames?q=<query> .
• Skalierbare Infrastruktur : Mit Docker erstellt, um sicherzustellen, dass der Dienst einfach bereitgestellt und skaliert wird.

Erste Schritte

Mit diesen Anweisungen werden Sie für die Entwicklung und Testzwecke eine Kopie des Projekts auf Ihrer lokalen Maschine in Betrieb genommen.

Voraussetzungen

• Git
• Machen
• Python 3,9 oder höher
• Poesiepaketverwaltung
• Docker und Docker komponieren

Installation (Docker)

1. Klonen Sie das Repository klonen

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

cd geonames-search

2. Starten Sie die Infrastruktur

Verwenden Sie den Befehl make up , um die OpenSearch -Instanz, den Redis -Cache und den Geonames -Suchdienst zu starten.

make up

3.. Index Geonames

Um die Geonames -Daten zu indizieren, können Sie das Geonames Index -Projekt verwenden.

Entwicklung

1. Klonen Sie das Repository klonen

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

cd geonames-search

2. Installieren Sie Abhängigkeiten

Installieren Sie alle notwendigen Python -Abhängigkeiten mit Poesie.

poetry install --with dev

3. Führen Sie die Anwendung aus

Starten Sie die Flask -Anwendung.

FLASK_APP=geonames_api/main.py flask run

Jetzt sind Sie bereit zu entwickeln!

Verwendung

Um den Geonames -Suchdienst zu verwenden, senden Sie einfach eine Get -Anfrage mit Ihrer Suchabfrage an den Endpunkt:

 GET /geonames?q=London

Die Antworten enthalten übereinstimmende geografische Daten aus der Geonames -Datenbank.

Beitragen

Wir begrüßen Beiträge! Wenn Sie Vorschläge für Verbesserungen oder Fehlerbehebungen haben, können Sie das Repository gerne aufgeben und eine Pull -Anfrage einreichen.

Lizenz

geonames-search wird unter der MIT-Lizenz verteilt. Weitere Informationen finden Sie unter Lizenz.