https://github.com/shuffle/shufflepy
Connect to your favorite services with a single line of code
https://github.com/shuffle/shufflepy
ai api automate lam llm ml shuffle singul soar
Last synced: 7 months ago
JSON representation
Connect to your favorite services with a single line of code
- Host: GitHub
- URL: https://github.com/shuffle/shufflepy
- Owner: Shuffle
- License: mit
- Created: 2024-05-11T15:04:36.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-11-26T14:44:06.000Z (7 months ago)
- Last Synced: 2024-12-11T11:52:06.270Z (7 months ago)
- Topics: ai, api, automate, lam, llm, ml, shuffle, singul, soar
- Language: Python
- Homepage: https://shuffler.io/docs/API#integration-layer
- Size: 53.7 KB
- Stars: 1
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Shufflepy
Connect to your favorite services with a single line of code.
**This Library is in an Experimental Phase**
## Installation
```bash
pip install shufflepy
```
## Configuration
```python
from shufflepy import Shuffle
## If the config is not specified, the library will use `https://shuffler.io` as the default URL. You must specify an apikey.
shuffle = Shuffle(
"APIKEY",
url='https://shuffler.io',
)
```
## Requirements
- [An API-key for Shuffle](https://shuffler.io/settings)
- Having an active authentication for the service you are trying to connect to in Shuffle, whether in your own instance or in the Shuffle cloud: [https://shuffler.io](https://shuffler.io/admin?tab=app_auth). This will be added to the future Shuffle CLI, and is also doable with the [App Authentication API](https://shuffler.io/docs/API#add-app-authentication).
- **If onprem**: [A Shuffle instance](https://github.com/shuffle/shuffle).
## Usage
Sample functions below. If none of these match, try to use the shuffle.connect() function to run ANYTHING. By default returns the [matching translation standard](https://github.com/Shuffle/standards/tree/main/translation_standards) if available, otherwise the raw output.
```python
shuffle.create_ticket("jira", title="Title")
shuffle.send_message("slack", message="Test")
shuffle.send_message("teams", message="Test")
shuffle.upload_document("google drive", file_id="x")
tickets = shuffle.list_tickets("jira")
```
## Manual:
```python
# General connect
tickets = shuffle.connect(
app='jira',
action='list_tickets',
fields={
"max-amount": 10
}
)
# Returns output according to the 'list_tickets' standard
print(tickets)
# General transformer - Transforms from any data into a standard, e.g. "list_tickets"
sourcedata = [{"title": "Tickettitle", "id": "hiya"}]
tickets = shuffle.transform(sourcedata, "list_tickets")
print(tickets)
```
Basic output for `list_tickets`:
```json
[{
"id": "P-123",
"title": "Ticket 1"
},
{
"id": "P-124",
"title": "Ticket 2"
}]
```
[See default standards](https://github.com/Shuffle/standards/blob/main/translation_standards) - Standards are modifiable, and you will see your own standards on the [File page in Shuffle](https://shuffler.io/admin?tab=files).
## Exploring usage
To look through past executions, see the execution debugger available on [/workflows/debug](https://shuffler.io/workflows/debug)
## Available Apps & categories
- [>2500 APIs: Search in Shuffle](https://shuffler.io/search?tab=apps)
## Available Categories (May 2024)
- Ticket management (Cases)
- Communication/Email (Comms)
- SIEM (SIEM)
- EDR/XDR (Eradication)
- Asset Management (Assets)
- Identity (IAM)
- Threat Intel (Intel)
- Cloud Security (Cloud)