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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.11.tar.gz
  • Upload date:
  • Size: 27.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.11.tar.gz
Algorithm Hash digest
SHA256 cbb3e62e2c65f2b5fa840b2585d98a14b5a132afa3fbae3ce5b65548bddcffe7
MD5 5e63600c8e99f45e7c74f21cccf5ed19
BLAKE2b-256 a381bfb90ff612650c7edb17481f3e2b921ae31081d0412e494fd41511f3cc6c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.11-py3-none-any.whl
  • Upload date:
  • Size: 34.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.11-py3-none-any.whl
Algorithm Hash digest
SHA256 38d5ccae9705cec0554710b148065c661667ca2ed706e3ca76f439ada35a88a6
MD5 a13a3db216f81162cfa31b41799e8386
BLAKE2b-256 4368c33e4757dd73d0bb24155813b3eb8549b2e2715bc2567d71f7cebca92f59

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