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.4.tar.gz (21.3 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.4-py3-none-any.whl (26.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.4.tar.gz
  • Upload date:
  • Size: 21.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.8 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for aiq_platform_api-0.2.4.tar.gz
Algorithm Hash digest
SHA256 df4573368c4be0b104c096715827fabb6641a2c5d056324acd8d09ce7fb45e31
MD5 11f0eb8421886ad302a5c9028661f925
BLAKE2b-256 2ac179bfc2e8856ccedb6e39812e8d1d46ee3cfd3adcddcc6a100cdaf0b573e6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.4-py3-none-any.whl
  • Upload date:
  • Size: 26.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/2.1.3 CPython/3.11.8 Linux/6.6.87.2-microsoft-standard-WSL2

File hashes

Hashes for aiq_platform_api-0.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 1e43293fbdff26692fb37363e5215ada7d0013abf9be972782fcfcb6b81c03ee
MD5 bf1d650590def4ee91e216a02a43ce77
BLAKE2b-256 a92178c2ab0d63d568d70eda603ac5beca5f0fe9982b6d64e9f327dfb6c7f240

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