Metadata-Version: 2.4
Name: maps-by-people-api
Version: 0.0.3
Summary: Maps by People - API
License-File: LICENSE
Author: danialcala94
Author-email: danielalcalavalera@gmail.com
Requires-Python: >=3.10,<3.12
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: beanie (>=2.1.0,<9999.0.0)
Requires-Dist: fastapi (>=0.141.1,<9999.0.0)
Requires-Dist: uvicorn (>=0.52.0,<9999.0.0)
Requires-Dist: yta_web_scraper (>=0.3.8,<1.0.0)
Description-Content-Type: text/markdown

# Maps by People - API

The module to provide information about the places we have in our database.

## Endpoints

#### GET
- `/places`
  - To obtain all the places that are registered.
- `/places/{place_id}`
    -  To obtain a specific place with the given `place_id` (by now is giving a hardcoded one).
-  `/place/categories`
    - To obtain the categories that are registered in our system.
- `/social-videos`
  - To obtain all the social videos that are registered.
- `/temporary-places`
  - To obtain all the temporary places that are registered.


#### POST
- `/places`
  - To register a new place.
- `/social-videos`
  - To register a new social video.
- `/temporary-places`
  - To register a new temporary place.


## Instructions
This API can be run locally and use the `maps-by-people-add-place` (also run locally) to enter with the phone in order to add new temporary places that then will be processed with our scripts (here in `maps-by-people-api`) to be transformed into definitive places with the information that is scraped. Check the `run_server.bat` files in both projects to do it.
