geonames search

Geonames 검색

Geonames Search는 간단하고 효율적인 인터페이스를 통해 지리적 데이터의 쿼리를 용이하게하도록 설계된 Geonames 컨텐츠에 대한 전체 텍스트 검색 서비스입니다. Python, Flask 및 OpenSearch를 사용하여 구축 된이 서비스는 캐싱 ​​용 Redis와 함께 데이터 저장 및 전체 텍스트 검색 기능을 활용하는 강력한 백엔드 인프라를 제공합니다.

참고 : 이것은 취미 프로젝트입니다.

특징

• 전체 텍스트 검색 : OpenSearch의 전체 텍스트 검색 기능을 사용하여 지리적 정보를 신속하게 찾으십시오.
• REST API : 간단한 엔드 포인트 /geonames?q=<query> 사용하여 Geonames 컨텐츠를 검색하십시오.
• 확장 가능한 인프라 : Docker와 함께 구축하여 서비스를 쉽게 배포하고 확장 할 수 있습니다.

시작하기

이 지침을 통해 개발 및 테스트 목적으로 로컬 컴퓨터에서 프로젝트 사본을 실행할 수 있습니다.

전제 조건

• git
• 만들다
• 파이썬 3.9 이상
• 시 패키지 관리
• Docker와 Docker Compose

설치 (Docker)

1. 저장소를 복제하십시오

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

cd geonames-search

2. 인프라를 시작하십시오

make up 명령을 사용하여 OpenSearch 인스턴스, Redis Cache 및 Geonames 검색 서비스를 시작하십시오.

make up

3. 색인 geonames

Geonames 데이터를 색인화하려면 Geonames Index 프로젝트를 사용할 수 있습니다.

개발

1. 저장소를 복제하십시오

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

cd geonames-search

2. 종속성을 설치하십시오

시를 사용하여 필요한 모든 Python 종속성을 설치하십시오.

poetry install --with dev

3. 응용 프로그램을 실행하십시오

플라스크 응용 프로그램을 시작하십시오.

FLASK_APP=geonames_api/main.py flask run

이제 개발 준비가되었습니다!

용법

geonames 검색 서비스를 사용하려면 검색 쿼리를 사용하여 엔드 포인트로 GET 요청을 보내기 만하면됩니다.

 GET /geonames?q=London

응답에는 Geonames 데이터베이스의 일치하는 지리적 데이터가 포함됩니다.

기여

우리는 기여를 환영합니다! 개선 또는 버그 수정에 대한 제안이 있으면 저장소를 포크하고 풀 요청을 제출하십시오.

특허

geonames-search MIT 라이센스에 따라 배포됩니다. 자세한 내용은 라이센스를 참조하십시오.