Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paloaltonetworks/pan-cortex-data-lake-python
Python idiomatic SDK for Cortex™ Data Lake.
https://github.com/paloaltonetworks/pan-cortex-data-lake-python
api applicationframework cortex data datalake directory directory-sync directory-sync-service event event-service logging logging-service paloalto paloaltonetworks pan pancloud panw python rest-api sdk
Last synced: 2 days ago
JSON representation
Python idiomatic SDK for Cortex™ Data Lake.
- Host: GitHub
- URL: https://github.com/paloaltonetworks/pan-cortex-data-lake-python
- Owner: PaloAltoNetworks
- License: isc
- Created: 2018-03-16T19:17:52.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2024-09-03T21:17:38.000Z (2 months ago)
- Last Synced: 2024-10-13T23:05:27.925Z (about 1 month ago)
- Topics: api, applicationframework, cortex, data, datalake, directory, directory-sync, directory-sync-service, event, event-service, logging, logging-service, paloalto, paloaltonetworks, pan, pancloud, panw, python, rest-api, sdk
- Language: Python
- Homepage: https://cortex.pan.dev/docs/data_lake/develop/cdl_python_installation
- Size: 1.27 MB
- Stars: 44
- Watchers: 14
- Forks: 18
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
README
  [](https://badge.fury.io/py/pan-cortex-data-lake)
# Palo Alto Networks Cortex™ Data Lake SDK
Python idiomatic SDK for the Cortex™ Data Lake.
The Palo Alto Networks Cortex Data Lake Python SDK was created to assist
developers with programmatically interacting with the Palo Alto Networks
Cortex™ Data Lake API.
The primary goal is to provide full, low-level API coverage for the
following Cortex™ Data Lake services:
- Query Service
The secondary goal is to provide coverage, in the form of helpers, for
common tasks/operations.
- Log/event pagination
- OAuth 2.0 and token refreshing
Resources:
- Documentation:
- Free software: [ISC license](https://choosealicense.com/licenses/isc/)
---
## Features
- HTTP client wrapper for the popular Requests library with full access to its features.
- Language bindings for Query Service.
- Helper methods for performing common tasks, such as log/event pagination.
- Support for OAuth 2.0 grant code authorization flow.
- Library of example scripts illustrating how to leverage the SDK.
- Support for API Explorer Developer Tokens for easier access to API!
## Status
The Palo Alto Networks Cortex™ Data Lake Python SDK is considered **beta** at this time.
## Installation
From PyPI:
```bash
pip install pan-cortex-data-lake
```
From source:
```bash
pip install .
```
To run tests:
```bash
pip install .[test]
```
## Obtaining and Using OAuth 2.0 Tokens
If you're an app developer, work with your Developer Relations representative to obtain your OAuth2 credentials. API Explorer may optionally be used to generate a Developer Token, which can also be used to authenticate with the API. For details on API Explorer developer tokens, please visit .
# Example
```python
from pan_cortex_data_lake import Credentials, QueryService
c = Credentials()
qs = QueryService(credentials=c)
query_params = {
"query": "SELECT * FROM `1234567890.firewall.traffic` LIMIT 1",
}
q = qs.create_query(query_params=query_params)
results = qs.get_job_results(job_id=q.json()['jobId'])
print(results.json())
```
# Contributors
