KoladaPy
A comprehensive Python wrapper for the Kolada API v3, providing access to Swedish municipality data.
Note: This is an independent project and is not associated with Kolada.
About Kolada
Kolada is a database containing key performance indicators (KPIs) for Swedish municipalities and regions. This wrapper provides a simple interface to search for KPIs, download data, and work with the results in Pandas DataFrames.
Features
- Search for KPIs with flexible filtering options
- Access metadata for KPIs, municipalities, and organizational units
- Download data with customizable parameters
- Convert results to Pandas DataFrames for easy analysis
- Automatic handling of pagination, validation and rate limits
- Support for all API endpoints including data for different regions and organizational units
Requirements
- Python 3.7 or higher
- Dependencies:
- requests>=2.25.0
- pandas>=1.1.0
- tqdm>=4.50.0
- backoff>=1.10.0
Installation
pip install koladapy
Quick Start
Visit the tutorials folder for a basic usage guide.
from koladapy import KoladaAPI
# Initialize the client
kolada = KoladaAPI()
# Search for KPIs related to school
kpis = kolada.search_kpis("skola")
print(f"Found {len(kpis)} KPIs related to 'skola'")
# Get a specific KPI by ID
kpi = kolada.get_kpi("N15033") # Pupils/teacher in primary school
print(f"KPI title: {kpi['title']}")
# Get the same data as a pandas DataFrame
df = kolada.get_data_as_dataframe(
kpi_id="N15033",
municipality_id="0180", # Stockholm municipality
years=[2020, 2021]
)
print(df.head())
Contributing
Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.
Resources
License
This project is licensed under the MIT License - see the LICENSE file for details.
Acknowledgements
This project uses the following open source packages:
The full license texts are available in the LICENSES directory.
Metadata
Release files for koladapy 1.0.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| koladapy-1.0.1.tar.gz | 13.7 kB | Without provenance | Details for koladapy-1.0.1.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| koladapy-1.0.1-py3-none-any.whl | Python 3 | none | any | Details for koladapy-1.0.1-py3-none-any.whl |
Total release size: 25.9 kB
Release files / koladapy-1.0.1.tar.gz
| Download URL | koladapy-1.0.1.tar.gz |
|---|---|
| Size | 13.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
fe2727f79358cf85feb3e504e56797642f8a7cbff8c024d5c5db4b03d4b363b1
|
|
BLAKE2b-256 checksum How to use checksums |
922d7c17c490d85b3a7af1a3c0cb590f282af863ea4eefc3b5d3ebf813e0e86d
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.5
|
Release files / koladapy-1.0.1-py3-none-any.whl
| Download URL | koladapy-1.0.1-py3-none-any.whl |
|---|---|
| Size | 12.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
fec31eaffdef813516e49bd5c22d12efbae179a5e5b62519dce818d18f97c26b
|
|
BLAKE2b-256 checksum How to use checksums |
b24d75e1c85733ea3dc56b8d0f0bbbd9a7ef12f964df89f8d24d08d3f969819f
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/6.2.0 CPython/3.11.5
|
Security for koladapy 1.0.1
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.