https://github.com/joegasewicz/geolocations-api

Town / City geolocations with FastAPI & Mongo
https://github.com/joegasewicz/geolocations-api

fastapi geolocation geolocation-api uk-geolocations

Last synced: 3 months ago
JSON representation

Town / City geolocations with FastAPI & Mongo

• Host: GitHub
• URL: https://github.com/joegasewicz/geolocations-api
• Owner: joegasewicz
• License: mit
• Created: 2021-12-08T18:17:29.000Z (about 3 years ago)
• Default Branch: master
• Last Pushed: 2022-01-26T21:04:52.000Z (about 3 years ago)
• Last Synced: 2023-03-02T21:22:46.301Z (almost 2 years ago)
• Topics: fastapi, geolocation, geolocation-api, uk-geolocations
• Language: Python
• Homepage: https://hub.docker.com/r/bandnoticeboard/geolocations-api
• Size: 1.48 MB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
[![Makefile CI](https://github.com/joegasewicz/geolocations-api/actions/workflows/makefile.yml/badge.svg)](https://github.com/joegasewicz/geolocations-api/actions/workflows/makefile.yml)

# Geolocations Api

Geolocations with FastAPI  & Mongo. United Kingdom is currently the only region supported but other regions will be supported in the future.

## Quick Start

1. Run mongodb

2. Clone & cd into the root folder of this repo

3. Setup a mongo database as a container - see [docker-compose example](https://github.com/joegasewicz/geolocations-api/blob/master/docker-compose.example.yml)

4. Make sure you have `mongoimport` (For Linux See [Installing the Database Tools on Linux](https://docs.mongodb.com/database-tools/installation/installation-linux/)) cmd installed & run the following make task:

```bash

# This will create a `towns` table in your db from the `towns.json` dump

make mongo-import-towns

# OR run the following cmd:

mongoimport -d bn_database -c towns --file ./towns.json --authenticationDatabase admin --username  --password  --host localhost --port 27017

```

5. Run the latest version of geolocations-api

```bash

docker run bandnoticeboard/geolocations-api

```

Or using docker-compose run mongodb & geolocation-api containers. See [docker-compose example](https://github.com/joegasewicz/geolocations-api/blob/master/docker-compose.example.yml)

# Example Queries

Currently, the api returns 5 entrees per query

Use the `name` query param to fetch the first 5 similar results:

```bash

curl http://localhost:6000/towns?name=col

```

Will return 

```bash

[

    {

        longitude: -6.32584,

        latitude: 58.2798,

        type: "Other",

        country: "Scotland",

        county: "Na h-Eileanan an Iar",

        reference: "COL",

        town: "Col",

        id: "56c4b2f97c82251d12547b6b"

    },

    ... # plus 4 other entrees

]

```

## Docker Compose Example

See [docker-compose.example.yml](https://github.com/joegasewicz/geolocations-api/docker-compose.example.yml)

```bash

version: "3"

services:

  geolocations_api:

# Uncomment if you are on Linux

#    extra_hosts:

#      - "host.docker.internal:host-gateway"

    image: "bandnoticeboard/geolocations-api:latest"

    ports:

      - "8000:8000"

    environment:

      API_DB_NAME: towns_db

      API_DB_USERNAME: admin

      API_DB_PASSWORD: admin

      API_DB_HOST: host.docker.internal

      API_DB_PORT: 27017

      SERVER_PORT: 8000

      SERVER_HOST: 0.0.0.0

```

## Contributing

PR's are welcome for bug fixes or open an issue.

For new features or adding new country geolocation dumps please open an issue first.