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.20.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.20-py3-none-any.whl (37.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.20.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.20.tar.gz
Algorithm Hash digest
SHA256 4af785a08fe088026139e6eecd30c4183ad8ee65111cd6cd0d33fe0ef16d03d5
MD5 1afe8f57a682057544e0b33c0869f21f
BLAKE2b-256 8e9cd7617a341b91af3f1b81939d32407cb3f659a6a5f50d0b4003b10bdf4403

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.20-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.20-py3-none-any.whl
Algorithm Hash digest
SHA256 a60481db2b981f80bc07f4475345ad3f7a8a13d0e9f4c8b0ba4d2ba53c4bdf65
MD5 1f7fef084b11e95eec9402e591b8c207
BLAKE2b-256 1e9127d6d53b60c08f91d2f54429518411a0c058b21575221e97e42507d0e75b

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