https://github.com/codeforberlin/jedeschule-api
API for JedeSchule.de
https://github.com/codeforberlin/jedeschule-api
api germany jedeschule python schools
Last synced: 5 months ago
JSON representation
API for JedeSchule.de
- Host: GitHub
- URL: https://github.com/codeforberlin/jedeschule-api
- Owner: codeforberlin
- Created: 2019-11-10T11:38:29.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2025-04-30T06:11:48.000Z (about 1 year ago)
- Last Synced: 2025-04-30T07:23:01.118Z (about 1 year ago)
- Topics: api, germany, jedeschule, python, schools
- Language: Python
- Homepage: https://jedeschule.codefor.de/docs
- Size: 68.4 KB
- Stars: 5
- Watchers: 4
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# jedeschule-api
API for the jedeschule.de project
Deployed at https://jedeschule.codefor.de/
API-Documentation at https://jedeschule.codefor.de/docs
## Setup
Before you start, make sure to have a postgres database running and accepting connections.
The database should be in the latest migration state as per the
migrations in the [jedeschule-scraper repository](https://github.com/datenschule/jedeschule-scraper).
In order to run the application locally in development mode, execute the following commands.
```bash
#(optional) create a virtual enviornment
export DATABASE_URL= # e.g. postgres://postgres@0.0.0.0:5432/jedeschule
pip install -r requirements.txt
pip install uvicorn
uvicorn app.main:app --reload
```
This will start a server which automatically restarts on file changes.