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.21.tar.gz (30.8 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.21-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.21.tar.gz
  • Upload date:
  • Size: 30.8 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.21.tar.gz
Algorithm Hash digest
SHA256 4d555aa7378e236122d94e04cb939da85067514a4e0a9b9a01ac94756526d7e0
MD5 680a02bfd237de21fbef329255a8f6a0
BLAKE2b-256 d9a1e16a7d858a475d77af51df0cd4604797eda9a1c55b2212e172c82c74407d

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.21-py3-none-any.whl
  • Upload date:
  • Size: 37.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.21-py3-none-any.whl
Algorithm Hash digest
SHA256 b96de4bbf945086a0ea0eaa83536097ff3f72e299fcfa56c821e4f5e257cd869
MD5 8e7c2392e1af38dadd0784f42470acba
BLAKE2b-256 727010645a1133091b02166e320c0826f4cd3b0a72fd83dad3aff345b38028a8

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