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.8.tar.gz (24.9 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.8-py3-none-any.whl (31.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.8.tar.gz
  • Upload date:
  • Size: 24.9 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.8.tar.gz
Algorithm Hash digest
SHA256 cf345502e79b605042ad13bccf5c0822528741fba1f144ce7477b9c2f4ae7313
MD5 70a097d63124e2fd97a453c58535af32
BLAKE2b-256 d71144c2c0abd2a0dd38b2ff0214371bfab27f20af7942f14b6ea2746760e6f4

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.8-py3-none-any.whl
  • Upload date:
  • Size: 31.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.8-py3-none-any.whl
Algorithm Hash digest
SHA256 998f7dd938e977f07b6d8c55e910f0235e3e36c7712e0cf45cd65ecbe5ed7ecf
MD5 37ea797c60645186e7a7fa5889f522c5
BLAKE2b-256 dff907080b0df18ade4cf0e1be64c1e2c9856ed68479f3f8feb96e1e13cdd3fd

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