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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.16.tar.gz
  • Upload date:
  • Size: 30.0 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.16.tar.gz
Algorithm Hash digest
SHA256 71657ad83b32cf8467b69bf58d36a169d47a004b50925a9de7d7a6e099c0341f
MD5 3b3d8fe079733c0dc77d5b5d98fd3d55
BLAKE2b-256 4e95fd15861f13b53c9d22a736df1cb5dd64f0bab656507a540e4b4a1cd620e7

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.16-py3-none-any.whl
  • Upload date:
  • Size: 36.1 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.16-py3-none-any.whl
Algorithm Hash digest
SHA256 e3699810972bd9453ad92a253e9e9a0ca43b0398d3477bd34acdb0e6d5ea7094
MD5 bb73652ce8b3718892a31915be444297
BLAKE2b-256 38fdd416ef5b4279662087635d2967929ac021e923e5fb979a93061f94ce2af2

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