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.25.tar.gz (36.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.25-py3-none-any.whl (40.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.25.tar.gz
  • Upload date:
  • Size: 36.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.25.tar.gz
Algorithm Hash digest
SHA256 f4ed5bc47778b1ea32adb677b20fa436946001f502acafcd59d9bcd238bfb49b
MD5 dfec9005ff16a5056957f50e6b4f82e7
BLAKE2b-256 a6829ccaf955510e7bb168b9d1743dc3ab9deeb43f147d8e95a07a2ebc68c421

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.25-py3-none-any.whl
  • Upload date:
  • Size: 40.3 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.25-py3-none-any.whl
Algorithm Hash digest
SHA256 45476acab6064c04153d09730fb5fbae214fa4cc3e7f2c68d8a3bad955737cb0
MD5 1fab603f7200c9993a354d26a2d08e4c
BLAKE2b-256 281f58effd02b7de4d0e445a819253b2bad74e852de3970a449ce17941237693

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