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.13.tar.gz (29.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.13-py3-none-any.whl (35.4 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.13.tar.gz
  • Upload date:
  • Size: 29.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.13.tar.gz
Algorithm Hash digest
SHA256 7fdb7c93f347e9fa4a7df0b6901e0b9314cacd38d3a3e55e6a589adab2d509ef
MD5 8ab51ed021123240f572dca191cae42d
BLAKE2b-256 b811408898cb4c9827c25dfaae934a87bf3caff062785ab50c0472af0807d536

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.13-py3-none-any.whl
  • Upload date:
  • Size: 35.4 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.13-py3-none-any.whl
Algorithm Hash digest
SHA256 31bdad8375cc7de2844586a7fa642612d47780ae55f4e45b685b3dbaa054835c
MD5 0d96b5cf8a7b7ec84a91dd41f33fe2e5
BLAKE2b-256 08a407b0c7ed6819b4f4e6bfc5ee13c9ca442483af8a9e329fad842bae107645

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