palestine-api is a simple Fastapi integrated with palestine-datasets. The main purpose is to make a quick and simple API for requesting the latest data available from palestine-datasets.
In order to run the project we need python>=3.12
and uv
for package management.
Install uv following the offical repo
To install the application:
uv venv
source .venv/bin/activate
uv pip sync requirements.txt
Windows:
uv venv
.venv\Scripts\activate
uv pip sync requirements.txt
To start a local copy of the app on port 3000
:
uvicorn main:app --reload
PENDING
PENDING
To check the code and styles quality, use the following command:
# Lint your code
ruff check
# Format your code
ruff format
PENDING
This project uses data from palestine-datasets, a curated list of reputable sources. Check out their repo and site for more in depth data questions as a database.
PENDING
Got Questions? Join the conversation in our Discord.
MIT ยฉ palestine-api