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.19.tar.gz (30.1 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.19-py3-none-any.whl (36.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.19.tar.gz
  • Upload date:
  • Size: 30.1 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.19.tar.gz
Algorithm Hash digest
SHA256 1d5d8b540f90c72c558bd21c461709798d9770c65ed927850be1811d5b8dea0b
MD5 4193dfa2dac96e5568a7e13958e195b9
BLAKE2b-256 edff809bc9c626d08a11795e3117dce553c5f942053a6163adbcc8be291cb470

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.19-py3-none-any.whl
  • Upload date:
  • Size: 36.2 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.19-py3-none-any.whl
Algorithm Hash digest
SHA256 e9df719a094b19c4fcc8709ef3302c175ead46f21ca1070d52bb93eb095f95d0
MD5 8333726f694a40cbec22ead6aeab0e3f
BLAKE2b-256 2d2f141d078ae695f76f885b6879034dece78ccfa7a1c8714b7a26b97d5f127a

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