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.17.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.17-py3-none-any.whl (36.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.17.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.17.tar.gz
Algorithm Hash digest
SHA256 7fb9cffb6a3b2379316dc467f9067a5090c2cd5e9fe0948f036487301fae8438
MD5 d8638c0c21777a360420cfbe63e33c93
BLAKE2b-256 fa37736d46f6acfaf6176df9912aca6c2ebd9b83f071160205547a02cb8829a3

See more details on using hashes here.

File details

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

File metadata

  • Download URL: aiq_platform_api-0.2.17-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.17-py3-none-any.whl
Algorithm Hash digest
SHA256 9d1c9a8cc1394473d1477c88b107adac05ffa1ad766b975d31fb8c597ed226bf
MD5 ed1b4360c8426b98a18ba7091c789280
BLAKE2b-256 b711f011e40e6e408dc3c57909b1ad9e99ea7a3aeba912ad2bc8986981b0f08f

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