pywarsaw 0.1.1
An unofficial asynchronous API wrapper for Warsaw Open Data - https://api.um.warszawa.pl/
License: MIT
Requires Python: >=3.9,<4.0
Keywords: Warsaw

# pywarsaw
![actions](https://github.com/BrozenSenpai/pywarsaw/actions/workflows/python-package.yml/badge.svg)[![Documentation Status](https://readthedocs.org/projects/pywarsaw/badge/?version=latest)](https://pywarsaw.readthedocs.io/en/latest/?badge=latest)[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)[![Downloads](https://static.pepy.tech/badge/pywarsaw)](https://pepy.tech/project/pywarsaw)

An unofficial asynchronous API wrapper for [Warsaw Open Data](https://api.um.warszawa.pl/).

Created mainly for learning purposes.

Package is still in progress, check the work status in the *currently covered* section.

## Features
- **Asynchronous**: designed to work with asyncio
- **Extensive**: cover as many endpoints as possible
- **Approachable**: all polish fields translated to english
- **Responsible**: minimize the load on the API server
    - implemented caching
- **Simple**: easy to use and customize:
    - object-oriented design
    - use of data transfer objects
    - type hinting
    - convert adequate fields from strings to the more suitable types
- **Lightweight**: minimal usage of the third-party packages

## Installation
```
pip install pywarsaw
```

## Getting started
The package goal is to be straightforward to use. For example, you can obtain a list of objects with information about current air quality in Warsaw, with caching enabled like this:
```python
import asyncio
import pywarsaw

async def main():
    client = pywarsaw.Mermaid(api_key="YOUR_API_KEY")
    await client.cache_enable()

    result = await client.get_air_quality()
    
    await client.close()

asyncio.run(main())
```
Or with the context manager:
```python
async with pywarsaw.Mermaid(api_key="YOUR_API_KEY") as client:
    await client.cache_enable()
    
    result = await client.get_air_quality()
```
Caching can be disabled with:
```python
await client.cache_disable()
```
Every object from the obtained list an be converted to the simpler structures:
```python
# convert object to the dictionary
result_dict = result[0].to_dict()

# convert object to the tuple
result_tuple = result[0].to_tuple()

# convert object to the flat dict - useful for creating Pandas dataframes
result_flat = result[0].to_flat_dict()

# convert object to the json string
result_json = result[0].to_json()
```

## Currently covered
Warsaw Open Data has a lot of different endpoints and data categories to cover.

The current status of work is:

**Culture**
* culture (vector maps):
    * theathers :heavy_check_mark:

**Public transport**
* ZTM timetables:
    * stops :heavy_check_mark:
    * lines :heavy_check_mark:
    * timetables :heavy_check_mark:
* transport (vector maps):
    * cycle stations :heavy_check_mark:
    * cycle tracks :heavy_check_mark:
    * parking lots :heavy_check_mark:
    * subway entrances :heavy_check_mark:
* stops information:
    * coordinates :heavy_check_mark:
    * current day coordinates :heavy_check_mark:

**Education**
* computers and internet access:
    * internet access :heavy_check_mark:
    * computers purpose :heavy_check_mark:
* statics about schools :x:
* education - rooms :x:
* schools :x:

**Ecology**
* shrubs:
    * shrubs :heavy_check_mark:
    * groups of shrubs :heavy_check_mark:
* forests:
    * forests :heavy_check_mark:
* trees:
    * groups of trees :heavy_check_mark:
    * trees :heavy_check_mark:
* munincipal waste:
    * waste segregation :heavy_check_mark:
* air quality:
    * air quality :heavy_check_mark:

**Online data**
* trams and buses:
    * trams and buses :heavy_check_mark:
* queuing systems :x:
* road works:
    * companies :heavy_check_mark:
    * categories :heavy_check_mark:
    * districts :heavy_check_mark:
    * investments :heavy_check_mark:
    * investments details :x:

**Spatial data**
* ATMs :x:
* names of urban objects :x:
* health :x:
* bikes :x:
* sport :x:
* accommodation :x:

**Safety**
* defibrillators:
    * defibrillators :heavy_check_mark:
* safety (vector maps) :x:

**Official data**
* administration (vector maps) :x:
* 19115 :x:
* sport :x:
* events :x:

## Terms of data usage
Translated from [here](https://api.um.warszawa.pl/#).

Public data available on the service are official materials and as such are not protected by copyright law. You may use this data freely but must comply with the conditions for reusing public information outlined in the law on the reuse of public sector information of 25th February 2016.

When using public information made available on the Open Data After Warsaw service, you must:
* Include information about the source of the data, including the name: Capital City of Warsaw, and the URL of the Open Data After Warsaw service: http://api.um.warszawa.pl (if possible)
* Provide the date of creation and acquisition of public information

Reusing public sector information available on the service is done at your own risk. The Capital City of Warsaw assumes no responsibility for any damage resulting from your or other users' reuse of this information. Some of the information processed by third parties that you may reuse may be outdated or contain errors, and the Capital City of Warsaw reserves the right to this possibility.

## Documentation
The documentation is hosted on [ReadTheDocs.io](https://pywarsaw.readthedocs.io/en/latest/)

## Help, questions, and contributing
All contributors are very welcome. If you have any questions or a bug to report feel free to open an issue.

## External packages
Pywarsaw depends on these third-party packages:


* [attrs](https://www.attrs.org/en/stable/)
* [aiohttp](https://docs.aiohttp.org/en/stable/)
* [aiohttp-client-cache](https://pypi.org/project/aiohttp-client-cache/)
* [aiosqlite](https://github.com/omnilib/aiosqlite)