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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.7.tar.gz
  • Upload date:
  • Size: 22.2 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.7.tar.gz
Algorithm Hash digest
SHA256 f525dad6d1d8535f99f0aaeb40a43db1be79dbcfa139565ca2b56c89d61ec033
MD5 d1a8e0f9b9d9defa4b08a958df08d899
BLAKE2b-256 7a8fbe0b462b240846f01c38bc5b4dab49d2ce62954c8030de99cc27dd64b826

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.7-py3-none-any.whl
  • Upload date:
  • Size: 26.9 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.7-py3-none-any.whl
Algorithm Hash digest
SHA256 db891764eec4411b850f8c8c862b6fcf45d81eb16409e6b89e02fa617fedb76b
MD5 d52e9904593b445803096958307bc892
BLAKE2b-256 130123e1ec84c2d6f2e98bf9b14ee7289ea9131cf7a6a368a3b07663b43e0586

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