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.15.tar.gz (29.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.15-py3-none-any.whl (36.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.15.tar.gz
  • Upload date:
  • Size: 29.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.15.tar.gz
Algorithm Hash digest
SHA256 f07eb72930229e8d059c3d7fd16fc98a531946dabc8e6ce6c6ee162ad3a7a2b3
MD5 f828b87b8c23fdff51dd22f979e1a663
BLAKE2b-256 e7f6e7a8a96ba269b0f194f2af5e781c5df370f4170cf32db646b5cf6c3d5b78

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.15-py3-none-any.whl
  • Upload date:
  • Size: 36.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.15-py3-none-any.whl
Algorithm Hash digest
SHA256 385408a53c2faa29a2d757f9dc7152c643bf88251a3ae5718f90353efe5b18c2
MD5 3d9c1f9ad805e8ee63ebb6422bf3314f
BLAKE2b-256 bc289a9380ec0e0626cb9e479849f8bc4e1ad465a86f0f35900d8987163e68d1

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