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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.6.tar.gz
  • Upload date:
  • Size: 21.6 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.6.tar.gz
Algorithm Hash digest
SHA256 6f7c02b27210fa16942df829cc9c097caac7274cc64120f546b4d3eb4effcb57
MD5 01ec1916b8da40fd2b46043869b5e390
BLAKE2b-256 5d1cfc2e7caeeae6aad53bd6ca5e1a3ea671e9cf033986792979c8e6685c9707

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.6-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.6-py3-none-any.whl
Algorithm Hash digest
SHA256 3c3617953a4769158c8d091ff3373e511b982990a61997403a34fc81fa785438
MD5 d2a1515bbed11271f10ee59be0aab491
BLAKE2b-256 bf5996a7df2c29f3e4e44207d38fb8d214f09ad143137f7c9d84c83ae566c3b8

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