Skip to content

Commit

Permalink
Migration to underscores
Browse files Browse the repository at this point in the history
  • Loading branch information
domenicoblanco committed Mar 27, 2024
1 parent ee808fd commit 2eb922e
Show file tree
Hide file tree
Showing 5 changed files with 15 additions and 5 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# DAB Live! client
# DAB Live! api
A simple Python client to obtain information about your connected pump and enable power shower.

## Installation
Just use `pip` to install this module
```
pip3 install dab-live-api
```
> [!NOTE]
> On Windows you should use `pip` instead of `pip3`

## How to use
Just instantiate the class `DAB`, it supports three optional parameters:
- `email`: your DAB Live! email
Expand All @@ -13,4 +22,5 @@ Just instantiate the class `DAB`, it supports three optional parameters:

To get data for each of your installations you can use `request_installation_data`, it accepts an optional parameter, `installation_id`, to obtain data only for a pump.

Give a look to the [init](dab-live-api/examples/getting_started.py) to better understand how it works
> [!IMPORTANT]
> Give a look to the [init](dab_live_api/examples/getting_started.py) to better understand how it works
2 changes: 1 addition & 1 deletion dab-live-api/__init__.py → dab_live_api/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
from json import dumps, loads, JSONDecodeError
from asyncio import get_event_loop, create_task, new_event_loop
from datetime import datetime
import const
from .const import *
import logging

class DAB():
Expand Down
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
from dab-live-api import DAB
from dab_live_api import DAB
from getpass import getpass
from asyncio import run

Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
[project]
name = "dab-live-api"
name = "dab_live_api"
readme = "README.md"
authors = [
{ name = "Domenico Blanco", email = "domenicog.blanco@gmail.com" }
Expand Down

0 comments on commit 2eb922e

Please sign in to comment.