ummahrican/palestine-api

Simple FastAPI to expose data provided by data.techforpalestine.org

palestine API

A Simple Fastapi for https://data.techforpalestine.org/docs/datasets/

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.

📖 Prerequisites

In order to run the project we need python>=3.12 and uv for package management.

Install uv following the offical repo

🖥️ Local development

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

🧪 Test

PENDING

📦 Docker builds

PENDING

🎨 Code linting

To check the code and styles quality, use the following command:

# Lint your code
ruff check

# Format your code
ruff format

🚀 Production deployment

PENDING

💾 Database

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.

🤝 Contributing

PENDING

🍕 Community

Got Questions? Join the conversation in our Discord.

⚖️ LICENSE

MIT © palestine-api

palestine-api's Issues

API endpoints

Hey 👋🏻 was just adding this to our examples page and noticed in your code you're referencing the github files and not our API endpoints.

It's worth noting that if we change the locations of these files in the repository that we're not considering that a breaking change. We version our own API for that reason, to allow old endpoints to continue to function as they used to while we introduce major changes in the future, including to our code structure. For that reason I'd recommend using our documented API endpoints and not querying raw github content

This is important if you intend for us to refer to this library as a canonical example of how others can use our API or build their own on top of it.

For example these lines:

palestine-api/main.py

Lines 6 to 8 in 5f5bd90

	casualties_url = "https://raw.githubusercontent.com/TechForPalestine/palestine-datasets/b0328917f163c55fb03de6184395bafdd22b35ec/casualties_daily.min.json"
	killed_url = "https://raw.githubusercontent.com/TechForPalestine/palestine-datasets/b0328917f163c55fb03de6184395bafdd22b35ec/killed-in-gaza.min.json"
	westbank_url = "https://raw.githubusercontent.com/TechForPalestine/palestine-datasets/b0328917f163c55fb03de6184395bafdd22b35ec/west_bank_daily.min.json"

should instead be

casualties_url = "https://data.techforpalestine.org/api/v2/casualties_daily.min.json"
killed_url = "https://data.techforpalestine.org/api/v2/killed-in-gaza.min.json"
westbank_url = "https://data.techforpalestine.org/api/v2/west_bank_daily.min.json"

These links are right in the docs pages

• Killed List
• Gaza Daily Casualties
• West Bank Daily Casualties