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

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.5.tar.gz
  • Upload date:
  • Size: 21.3 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.5.tar.gz
Algorithm Hash digest
SHA256 a4459d2e3f635eb81523ebe313b6f9cf189be286cf89959d83f259417abcbddf
MD5 9e44194bb813b975649f3a4d0b10c873
BLAKE2b-256 9cff217b597a4368daf8639ba6d913493978526950b3ef44dc15d26d7da41ebe

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 26.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.5-py3-none-any.whl
Algorithm Hash digest
SHA256 2330fd6a8cdd3e15830c2f73ce776b3c2838cc5a32dd2d9f5c93aad6ed24f9e2
MD5 843d873822b77491b664e08988e84d54
BLAKE2b-256 55a148d687764f6096997f8c6d94d73447081a6ef0897a7f0c33755adf7cf5f3

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