Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adding doc to use the CLI (closes #6) #7

Merged
merged 3 commits into from Jun 9, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
38 changes: 37 additions & 1 deletion README.md
@@ -1,4 +1,40 @@
PyBerdrola
==========

PyBerdrola allows to get info and invoices about the electric consumption.

This info is obtained from the iberdrola.es using the same APIs that iOS app is using.


Installation
------------
```bash
pip install pyberdrola
```


Using pyberdrola
----------------
**pyberdrola** requires two variables (`IBUSER` and `IBPASS`) to be able to log in.

```bash
# the same that you're using to login in https://www.iberdrola.es/
export IBUSER='your_username'
export IBPASS='your_pass'
```

After that, you can use the CLI:

```bash
# Show a list of all your invoices (date, consumption and price)
pyberdrola all

# Show info about your last invoice
pyberdrola last

# Show the help menu
pyberdrola --help
```

License
-------
Read the [LICENSE file](LICENSE).
2 changes: 1 addition & 1 deletion pyberdrola/__init__.py
@@ -1 +1 @@
__version__ = "0.0.8"
__version__ = "0.0.9"