Metadata-Version: 2.3
Name: aiq-platform-api
Version: 0.2.6
Summary: Utility functions for AttackIQ Platform API usage
License: MIT
Author: Rajesh Sharma
Author-email: rajesh.sharma@attackiq.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: ipython (>=7.34.0,<9.0.0)
Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
Requires-Dist: requests (>=2.31.0,<3.0.0)
Requires-Dist: tenacity (>=8.2.3,<9.0.0)
Description-Content-Type: text/markdown

# AttackIQ Platform API Utilities

⚠️ **BETA / WORK IN PROGRESS** ⚠️

This package provides utility functions for interacting with the AttackIQ Platform API.

## Status

This project is currently in beta and under active development. Features and APIs may change without notice. Feedback and contributions are welcome!

## Installation

```bash
virtualenv venv
source venv/bin/activate
pip install --upgrade aiq-platform-api python-dotenv
```

## Prerequisites
- Python 3.9+
- Valid AttackIQ Platform credentials
- Basic familiarity with API concepts

## Examples

To get started quickly with the example code:

1. Copy the example files to your project:
```bash
cp examples/basic_usage.py your-project/
cp examples/.env.example your-project/.env
```

2. Configure your credentials:
```bash
# Edit .env file with your AttackIQ Platform credentials
vim .env
```

3. Run the example:
```bash
python basic_usage.py
```

## Contributing

We welcome feedback and contributions! For detailed contribution guidelines, please see [CONTRIBUTING.md](CONTRIBUTING.md).

Quick ways to contribute:
- Open issues for bugs or feature requests
- Submit pull requests
- Provide feedback on the API design

## License

MIT License - See LICENSE file for details
