Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/edmartt/wrapper-piper
this microservice calculates the distance of two coordinates via publish/subscribe queue
https://github.com/edmartt/wrapper-piper
docker docker-compose euclidian-distance flask publish-subscribe python redis rq unit-testing
Last synced: 13 days ago
JSON representation
this microservice calculates the distance of two coordinates via publish/subscribe queue
- Host: GitHub
- URL: https://github.com/edmartt/wrapper-piper
- Owner: Edmartt
- Created: 2023-06-29T08:30:57.000Z (over 1 year ago)
- Default Branch: dev
- Last Pushed: 2024-01-11T21:05:06.000Z (about 1 year ago)
- Last Synced: 2024-12-06T09:26:14.615Z (2 months ago)
- Topics: docker, docker-compose, euclidian-distance, flask, publish-subscribe, python, redis, rq, unit-testing
- Language: Python
- Homepage:
- Size: 81.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WRAPPER PIPER
This microservice is in charge of, through an endpoint, receiving a list of ids of locations previously added with the [locstorager service](https://github.com/Edmartt/locstorager), sending this list of ids to an input queue, searching the locations corresponding to this list of ids, extracting their latitude and longitude to calculate the distance of these locations using the Euclidean distance formula.
The idea behind this project is to fulfill some specific requirements that consist in calculating the distance with the euclidean formula, for this, two microservices are requested, one with the purpose of saving the locations with name, latitude and longitude, returning an id, [locstorager service](https://github.com/Edmartt/locstorager) and another, (this one) to send a list of ids that calculate the distance between the two points sent.
My approach was based on using a vertical slice architecture because of the very specific requirements and the ease of maintaining a feature in my opinion.
I have left one package out of the main code structure, which is the database access, because in the feature package, called methods, I have added a data access layer with interfaces to decouple the code from the database manager as much as possible, thus fulfilling an important SOLID principle such as dependency inversion. If tomorrow I change the type of database manager or want to store the data or query it in a different way, I would not have to change my methods, I would simply change the implementation.
### The wrapper-piper project structure
```
.
├── \
├── config.py
├── delivery_tables.sql
├── docker-compose.yml
├── Dockerfile
├── env.example
├── envrc.example
├── README.md
├── redis.conf
├── requirements.txt
├── run.py
├── setup.cfg
├── setup.py
└── src
├── calculator
│ ├── calc.py
│ ├── data_layer
│ │ ├── data_access_impl.py
│ │ ├── data_access_interface.py
│ │ └── __init__.py
│ ├── http_ids_handler.py
│ ├── http_job_handler.py
│ ├── __init__.py
│ ├── job_results.py
│ ├── models
│ │ ├── __init__.py
│ │ └── location.py
│ ├── routes.py
│ └── task.py
├── database
│ ├── database_interface.py
│ ├── __init__.py
│ ├── postgres.py
│ └── redis_mod.py
└── __init__.py
```
## Requirements
- Python 3.11
- Docker
- Docker Compose
- Redis
- Postgres
### Running
1. Clone the repo
```
git clone https://github.com/Edmartt/wrapper-piper.git
```
2. Browse into the project folder
```
cd wrapper-piper/
```
### Development Version with Flask
1. Create a virtual environment
```
python3 -m venv
```
2. Activate virtual environment
```
source env/bin/activate
```
3. Install dependencies
```
pip3 install -r requirements
```
4. Run
```
flask run -p
```
#### Note
We need to run with custom ports because this is the microservice that process the ids stored
by another service that we'll have running in a default port (or maybe a custom one)
### Running with Docker
1. Pull the image from Dockerhub
```
docker pull edmartt/wrapper-piper
```
2. Create a container
```
docker run --rm -p --env-file .env edmartt/wrapper-piper
```
##### Note
If we try to send requests to this service when is running alone with docker, we'll get an error because we don't have a database with the records for processing
### Deploying all the services with Docker Compose
1. set a .env file following the env.example
2. Run the following command
```
docker-compose up
```
Now you're ready for testing the services. Please read the api documentation here >>> [API DOCS](https://github.com/Edmartt/wrapper-piper/blob/dev/API-DOCS.md)