https://github.com/oslokommune/bydelsfakta-api
API for Bydelsfakta
https://github.com/oslokommune/bydelsfakta-api
dataplatform
Last synced: 5 months ago
JSON representation
API for Bydelsfakta
- Host: GitHub
- URL: https://github.com/oslokommune/bydelsfakta-api
- Owner: oslokommune
- License: mit
- Created: 2021-04-16T13:07:29.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-11-19T09:28:17.000Z (6 months ago)
- Last Synced: 2025-11-19T11:20:57.144Z (6 months ago)
- Topics: dataplatform
- Language: Python
- Homepage:
- Size: 1.01 MB
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Bydelsfakta-api
=============
Fetches the latest edition of given dataset.
The api fetches bydelsfakta data based on geography.
## Setup
1. Install [Serverless Framework](https://serverless.com/framework/docs/getting-started/)
2. Install Serverless plugins: `make init`
3. Install Python toolchain: `python3 -m pip install (--user) tox black pip-tools`
- If running with `--user` flag, add `$HOME/.local/bin` to `$PATH`
## Formatting code
Code is formatted using [black](https://pypi.org/project/black/): `make format`
## Running tests
Tests are run using [tox](https://pypi.org/project/tox/): `make test`
For tests and linting we use [pytest](https://pypi.org/project/pytest/), [flake8](https://pypi.org/project/flake8/) and [black](https://pypi.org/project/black/).
## Deploy
Deploy to dev is automatic via GitHub Actions, while deploy to prod can be triggered with GitHub Actions via dispatch. You can alternatively deploy from local machine with: `make deploy` or `make deploy-prod`.
## Input
Optional parameter geography, e.g. `geography=01`
## Output
The function returns the data from a bydelsfakta.