Metadata-Version: 2.3
Name: bits-aviso-python-sdk
Version: 1.10.9
Summary: Repository containing python wrappers to various services for bits-aviso.
License: MIT
Author: Miranda Nguyen
Author-email: mirandanguyen98@gmail.com
Requires-Python: >=3.11,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: apypie (>=0.6.2,<0.7.0)
Requires-Dist: dnspython (>=2.7,<3.0)
Requires-Dist: google-api-python-client (>=2.143.0,<3.0.0)
Requires-Dist: google-cloud-bigquery (>=3.27.0,<4.0.0)
Requires-Dist: google-cloud-pubsub (>=2.22.0,<3.0.0)
Requires-Dist: google-cloud-secret-manager (>=2.20.1,<3.0.0)
Requires-Dist: google-cloud-storage (>=2.18.0,<3.0.0)
Requires-Dist: pdoc (>=16.0.0,<17.0.0)
Requires-Dist: pre-commit (>=3.8.0,<4.0.0)
Requires-Dist: progressbar2 (>=4.5.0,<5.0.0)
Requires-Dist: pypuppetdb (>=3.2.0,<4.0.0)
Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
Description-Content-Type: text/markdown

# bits-aviso-python-sdk
Repository containing python wrappers to various services Team AVISO develops against.

[Link to Documentation](https://legendary-adventure-kgmn2m7.pages.github.io/)

---

## Installation
To install the SDK, you can use pip:
```bash
pip install bits-aviso-python-sdk
```

---
## Usage
Here is a simple example of how to use the SDK:
```python
from bits_aviso_python_sdk import ServiceName

service = ServiceName(username='username', password='password')  # Initialize the service
response = service.some_method()
print(response)
```
However, please refer to the documentation for each service for more specific parameters and methods.

---

## Sub Modules
There are three upper-level modules in this SDK:

### helpers
> Helpers are utility functions that assist with various tasks within the SDK.
They can also be used independently of the services. Functions that are commonly used will be included here.

Please see the documentation under `bits-aviso-python-sdk.helpers` for more information.

### services
> Services are the main components of the SDK. Each service corresponds to a specific functionality leveraged by
Team AVISO.

Please see the documentation under `bits-aviso-python-sdk.services` for more information.

### tests
> Tests are included to ensure the functionality of the SDK.
They can be run to verify that the SDK is working as expected.
>
> However, these are not proper unit tests and are a work in progress.

Please see the documentation under `bits-aviso-python-sdk.tests` for more information.

---

## Generating Documentation
The documentation for this SDK is generated using pdoc.
To generate the documentation, run the following command:
```bash
poetry run pdoc -o docs bits_aviso_python_sdk
```
This will create an HTML version of the documentation in the `docs` directory.
You may need to use the `--force` flag to overwrite existing files.

