Metadata-Version: 2.4
Name: pyenerginet
Version: 0.6
Summary: A package to extract data from Energinet and Energi Data Service
Project-URL: Homepage, https://github.com/edu230991/pyenerginet
Project-URL: Issues, https://github.com/edu230991/pyenerginet/issues
Author-email: Edoardo Simioni <edu230991@gmail.com>
License-File: LICENSE
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.9
Requires-Dist: numpy<1.27,>=1.26.4
Requires-Dist: pandas<2.3,>=2.2.1
Requires-Dist: requests-cache<2,>=1.2.1
Requires-Dist: requests<2.32,>=2.31.0
Description-Content-Type: text/markdown

# pyenerginet
A python package to facilitate using public data from Energinet.
Raw data available at https://www.energidataservice.dk/.

### Getting started

#### Colab notebook
You can test out the package and play around with it on [Colab](https://colab.research.google.com/github/edu230991/pyenerginet/blob/main/examples.ipynb).

#### Setting up locally
Clone repository:

```
git clone https://github.com/edu230991/pyenerginet.git
```

Create virtual environment (if you don't have `virtualenv`, just pip-install it) and activate it:

```
python -m virtualenv env
call env\Scripts\activate
```

Install dependencies (as well as local version of `pyenerginet`):

```
pip install -e .
```

To see whether the current package version works:
```
pip install pytest
python -m pytest
```

### Contributing 
Please feel free to request contributor access to edu230991.
Once you are a contributor, you will need to make a pull request and someone else will have to approve it before it is merged into main.

### Publishing
Set up following these guides:
- https://packaging.python.org/en/latest/tutorials/packaging-projects/
- https://packaging.python.org/en/latest/guides/publishing-package-distribution-releases-using-github-actions-ci-cd-workflows/

