Metadata-Version: 2.1
Name: optus
Version: 0.0.1
Summary: Python wrapper for the optus mobile API
Home-page: https://github.com/itchannel/optus-api
Author: itchannel
Author-email: steve@itchannel.me
License: MIT
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: requests

# Optus Mobile API Integration

This is a python wrapper for the Optus mobile API. It provides the ability to view account usage information and other capabilities normally only accessed via the mobile application. 

**Base64 auth is a generic token for the Optus API and does not contain credentials**


## Features

* Usage Information (Balance, data remaining etc)
* Addon information (Details of addons applied or avaliable for the account)
* Geofencing Information (Geofences that have been configured for the account)

## Install

Install using pip:
```
pip install optus
```


## Demo
To test the script there is a demo script that can be used
```
demo.py EMAIL PASSWORD MOBILE
```

Example
```
demo.py test@test.com password1 04123456
```

## Library Usage
Simple Usage
```
from optus import Account
acc = Account("email", "password", "mobile")
print(acc.usage())
```

