Skip to content

Add simple usage example #13

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.

Sign up for GitHub

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

Merged
joamag merged 1 commit into from
Jun 14, 2025
Merged

Add simple usage example #13

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,20 @@
| **BUDY_USERNAME** | `str` | `None` | The username to be used for authentication. |
| **BUDY_PASSWORD** | `str` | `None` | The password to be user for authentication. |

## Example

```python
import budy

api = budy.API(
username="my_user",
password="my_password"
)

api.login()
api.create_voucher_value(10)
```

## License

Budy API is currently licensed under the [Apache License, Version 2.0](http://www.apache.org/licenses/).
Expand Down