Skip to main content

Utility functions for AttackIQ Platform API usage

Project description

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

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:
cp examples/basic_usage.py your-project/
cp examples/.env.example your-project/.env
  1. Configure your credentials:
# Edit .env file with your AttackIQ Platform credentials
vim .env
  1. Run the example:
python basic_usage.py

Contributing

We welcome feedback and contributions! For detailed contribution guidelines, please see 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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiq_platform_api-0.2.0.tar.gz (15.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

aiq_platform_api-0.2.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file aiq_platform_api-0.2.0.tar.gz.

File metadata

  • Download URL: aiq_platform_api-0.2.0.tar.gz
  • Upload date:
  • Size: 15.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.2 Linux/5.15.167.4-microsoft-standard-WSL2

File hashes

Hashes for aiq_platform_api-0.2.0.tar.gz
Algorithm Hash digest
SHA256 0a1e6510847d2b5d279ff587cb0f7d48501f59f7ed0eda1316ce2928627a09ef
MD5 3574732c6e0318f20c35320fa69c3cd1
BLAKE2b-256 3e31b250b0d8dbadd55a68bddcabd739d6d0a7ca8c1645b8204c593bbbe87500

See more details on using hashes here.

File details

Details for the file aiq_platform_api-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: aiq_platform_api-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 23.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.8.3 CPython/3.12.2 Linux/5.15.167.4-microsoft-standard-WSL2

File hashes

Hashes for aiq_platform_api-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 2e10d33831298254194b5a8d64183ce03c4e0778ab9bd8da75953706c3f6483f
MD5 48e4befabf90ade6aa6e2b7d3590d097
BLAKE2b-256 a9a315ee19b7c7da0d4cfac14c625b5bad43ebd33c2a8449c19110827c3f9693

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page