Metadata-Version: 2.1
Name: basque-events
Version: 1.0
Summary: Package for interpretation of Event data in Euskadi
Home-page: https://github.com/naroabarrutia/basque_events
Author: Mikel Madariaga & Naroa Barrutia
Author-email: naroa.barrutia@alumni.mondragon.edu
License: MIT
Download-URL: https://github.com/naroabarrutia/basque_events/archive/refs/tags/v_1.0.tar.gz
Keywords: Events,Basque,Opendata
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Description-Content-Type: text/markdown
License-File: LICENSE.txt

# Event data from the Basque Country

This package has been developed using event data from the Open Data Euskadi api. Several functions have been created to facilitate users the interpretation of the data. The following variables have been used: 

-	Event type
-	Name of the event
-	Municipality
-	Establishment
-	Opening/Closing hours
-	Price
-	URL

## Functions

| Function | Description | Inputs |
| ------ | ------ | ------ |
| data_api | Used by other functions to obtain data from the api | Api URL |
| info_events | Gets event data from an specific month in  | Month, year & language (basque or spanish)  |
| year_data | Displays two barplots | Year and boolean value (True or False) |
| download | Downloads the data | Month, year and format (csv or json) |

## File structure
```sh
examples 
    datos_aÃ±o.JPG
```

```sh
basque_events
    basque_events.py
    __init__.py
```

```sh
LICENSE.txt
```

```sh
README.md
```

```sh
setup.cfg
```

```sh
setup.py
```
## Dependencies
- [Pandas] - Tools for manipulating different data types.
- [Matplotlib] - Graph creation.
- [Request] - Obtain requested data from the api.
- [Seaborn] - Easy to use data visualization.

## Use case
```python
import basque_events as be

# Event info from 2021/01
be.events_info(2021, 1, 'eus')

# Download data from 2021/05 in csv format
be.download(2021, 5, 'es', 'csv')

# Display two barplots with event data from 2021 
be.year_data(2021, True)
```

![Alt text](https://github.com/naroabarrutia/basque_events/blob/main/examples/datos_aÃ±o.JPG?raw=true)

## License
[MIT]

## Authors
>Mikel Madariaga & Naroa Barrutia 

[//]: # (These are reference links used in the body of this note and get stripped out when the markdown processor does its job. There is no need to format nicely because it shouldn't be seen)

[Pandas]: <https://pandas.pydata.org/>
[Matplotlib]: <https://matplotlib.org/>
[Request]: <https://pypi.org/project/requests/>
[Seaborn]: <https://seaborn.pydata.org/>
[MIT]: <https://choosealicense.com/licenses/mit/>

