An object-based approach to the QRadar Client API
Project description
qradar-api
This package contains an object oriented approach to the QRadar API. The idea is to keep the logic simple, structure and allow for an easy way to integrate with the QRadar API.
This package was inspired by: https://github.com/ryukisec/qradar4py who already put in some ground work when it came to an object oriented approach. This package goes further and adds models for the different object you can retrieve and post.
It is a work in progress though :)
Structure
the package contains
- Endpoints
- Inherit from base class
QRadarAPIClient
- Use decorators to define which headers and parameters are allowed for each endpoint
- located in src\qradar\api\endpoints
- Inherit from base class
- Models
- Inherit from base class
QRadarModel
, which provides them with a custom__repr__
andfrom_json()
factory - Located in src\qradar\models
- Inherit from base class
Installation
sudo pip3 install qradar-api
How to use
Roadmap
- Set up decent packaging :package:
- Implement all models & GET endpoints :rocket:
- Implement all post endpoints :pencil:
- Convince IBM to contribute when creating a new API version :pray:
- Write a nice set of unit tests :clown_face:
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
qradar-api-0.0.2.tar.gz
(7.5 kB
view hashes)
Built Distribution
qradar_api-0.0.2-py3-none-any.whl
(22.8 kB
view hashes)
Close
Hashes for qradar_api-0.0.2-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 22768a6167f212c40de87939bfdf034f3c899bcbb8cd26d8a07f33ae1d836f8f |
|
MD5 | 1583b4f2ae9ef9141482b478ee4cd7a6 |
|
BLAKE2b-256 | 98a1389cc7dfe76ca84dc29ecd284270d322fa540403183cdab07c4412e50302 |