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.2.tar.gz (20.2 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.2-py3-none-any.whl (28.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.2.tar.gz
  • Upload date:
  • Size: 20.2 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.2.tar.gz
Algorithm Hash digest
SHA256 3fcc8818d34c67a9031467d1a05463e83c560cc4fa334b7cdf98303aaf82679e
MD5 19e8e732522e98d2d08651537cc1fbac
BLAKE2b-256 63ede90cacb60d6fc079badc4caa352f7edc09b5deff6bad69bb31a6532cc6c6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.2-py3-none-any.whl
  • Upload date:
  • Size: 28.0 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.2-py3-none-any.whl
Algorithm Hash digest
SHA256 1e8ac932a2007cd5da0f4d8133f53302765b9ad2e3378d0f875b3223f84a9c75
MD5 92e951d6f67eb10796e95c96ef64aa3b
BLAKE2b-256 e7d2d1f7fa81ba75d992944f020354a3f9a76e920b99cf1dbacc8988da065739

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