Metadata-Version: 2.1
Name: vienna-smartmeter
Version: 0.3.0
Summary: Python library to access the Wiener Netze Smart Meter private API.
Home-page: https://github.com/platysma/vienna-smartmeter
License: MIT
Author: Platysma
Author-email: platysma.dev@gmail.com
Requires-Python: >=3.6.1,<4.0.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Provides-Extra: async
Requires-Dist: aiohttp (>=3.7.4,<4.0.0); extra == "async"
Requires-Dist: async_timeout (>=3.0.1,<4.0.0); extra == "async"
Requires-Dist: importlib-metadata (>=4.6.4,<5.0.0)
Requires-Dist: lxml (>=4.6.3,<5.0.0)
Requires-Dist: requests (>=2.24.0,<3.0.0)
Project-URL: Changelog, https://github.com/platysma/vienna-smartmeter/releases
Project-URL: Repository, https://github.com/platysma/vienna-smartmeter
Description-Content-Type: text/markdown

<h1 align="center">
  Vienna Smart Meter
</h1>
<h4 align="center">An unofficial python wrapper for the <a href="https://www.wienernetze.at/smartmeter" target="_blank">Wiener Netze Smart Meter</a> private API.
</h4>

[![PyPI Version](https://img.shields.io/pypi/v/vienna-smartmeter)](https://pypi.org/project/vienna-smartmeter/)
[![Build](https://github.com/platysma/vienna-smartmeter/actions/workflows/build.yml/badge.svg)](https://github.com/platysma/vienna-smartmeter/actions/workflows/build.yml)
[![Code Coverage](https://codecov.io/gh/platysma/vienna-smartmeter/branch/main/graph/badge.svg)](https://codecov.io/gh/platysma/vienna-smartmeter)
[![Code Quality](https://api.codeclimate.com/v1/badges/3130fa0ba3b7993fbf0a/maintainability)](https://codeclimate.com/github/platysma/vienna-smartmeter)

## Features

- Access energy usage for specific meters
- Get profile information
- View, edit & delete events (Ereignisse)

## Installation

Install with pip:

`pip install vienna-smartmeter`

An async package is provided and can be installed with the 'async' extra:

`pip install vienna-smartmeter[async]`

## How To Use

Import the Smartmeter client, provide login information and access available api functions:

```python
from vienna_smartmeter import Smartmeter

username = 'YOUR_LOGIN_USER_NAME'
password = 'YOUR_PASSWORD'

api = Smartmeter(username, password)
print(api.profil())
```

The asnyc package can be imported by replacing Smartmeter with AsyncSmartmeter.

```python
from vienna_smartmeter import AsyncSmartmeter

```

## Contributing

Pull requests are welcome. For major changes, please open an issue first to discuss what you would like to change.

Make sure to add or update tests as appropriate.

## License

> You can check out the full license [here](https://github.com/platysma/vienna-smartmeter/blob/main/LICENSE)

This project is licensed under the terms of the **MIT** license.

## Legal

Disclaimer: This is not affliated, endorsed or certified by Wiener Netze. This is an independent and unofficial API. Strictly not for spam. Use at your own risk.

