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.24.tar.gz (35.5 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.24-py3-none-any.whl (39.8 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.24.tar.gz
  • Upload date:
  • Size: 35.5 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.24.tar.gz
Algorithm Hash digest
SHA256 0193812203a67c926b72df3a22b6936cf5b7190f3b2e616bdeaff128733da389
MD5 ef0b883615b2b4d9f827f17c14eca9e5
BLAKE2b-256 9d3927a9fd8b721a990ea08dd06046261e4391586b8a30d6feb304f5b623f28b

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.24-py3-none-any.whl
  • Upload date:
  • Size: 39.8 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.24-py3-none-any.whl
Algorithm Hash digest
SHA256 30d8735cbc168008b6dce1dedd5b12f0d025a4288c0fe504050f9e8025610a7c
MD5 7ed5abc6b4428f482c47bea26e996729
BLAKE2b-256 8d8d0d09da604c2080da95dbd051716344419892de601805b36854f690b5e40f

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