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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for aiq_platform_api-0.2.23.tar.gz
Algorithm Hash digest
SHA256 5ff2f7b4019f653f46f4d3495d5e4e79955ce282b940bfce35df4d34663e0faf
MD5 2d5c3edf60ffb1b9b5ed67ad2c5bebba
BLAKE2b-256 9a5477c9a7095fe14453f730de88fe7edf986e47acc205d62e255f987a2b0155

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for aiq_platform_api-0.2.23-py3-none-any.whl
Algorithm Hash digest
SHA256 1a566dccfaa797b38099d85776db45eca7c8730ddd919f9143cf8cf8cd7fcd1a
MD5 2c70c19c8603f40a8b0cbc8649ff116a
BLAKE2b-256 9cde2a11e50e56498727f3917cd343790c90b7c88dcb6631a313492e95f24b05

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