Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/intelowlproject/pyintelowl
Robust Python SDK and Command Line Client for interacting with IntelOwl's API.
https://github.com/intelowlproject/pyintelowl
analysis cli click intel-owl intelowl-api intelowl-sdk intelowl-server rich sdk
Last synced: 5 days ago
JSON representation
Robust Python SDK and Command Line Client for interacting with IntelOwl's API.
- Host: GitHub
- URL: https://github.com/intelowlproject/pyintelowl
- Owner: intelowlproject
- License: agpl-3.0
- Created: 2019-10-30T17:00:17.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2024-10-29T02:43:17.000Z (4 months ago)
- Last Synced: 2024-10-30T05:42:34.744Z (4 months ago)
- Topics: analysis, cli, click, intel-owl, intelowl-api, intelowl-sdk, intelowl-server, rich, sdk
- Language: Python
- Homepage: https://pyintelowl.readthedocs.io
- Size: 3.84 MB
- Stars: 60
- Watchers: 9
- Forks: 26
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# PyIntelOwl
[](https://badge.fury.io/py/pyintelowl)
[](https://pypi.python.org/pypi/pyintelowl/)[](https://github.com/intelowlproject/pyintelowl/actions/workflows/pull_request_automation.yml)
[](https://codecov.io/gh/intelowlproject/pyintelowl)
[](https://www.codefactor.io/repository/github/intelowlproject/pyintelowl)Robust Python **SDK** and **Command Line Client** for interacting with [IntelOwl](https://github.com/intelowlproject/IntelOwl)'s API.
## Features
- Easy one-time configuration with self documented help and hints along the way.
- Request new analysis for observables and files.
- Select which analyzers you want to run for every analysis you perform.
- Choose whether you want to HTTP poll for the analysis to finish or not.
- List all jobs or view one job in a prettified tabular form.
- List all tags or view one tag in a prettified tabular form.## Demo
[](https://asciinema.org/a/z7L93lsIzOQ0Scve7hMl30mJJ?t=5)
## Installation
```bash
$ pip3 install pyintelowl
```For development/testing, `pip3 install pyintelowl[dev]`
## Quickstart
### As Command Line Client
On successful installation, The `pyintelowl` entryscript should be directly invokable. For example,
```bash
$ pyintelowl
Usage: pyintelowl [OPTIONS] COMMAND [ARGS]...Options:
-d, --debug Set log level to DEBUG
--version Show the version and exit.
-h, --help Show this message and exit.Commands:
analyse Send new analysis request
analyzer-healthcheck Send healthcheck request for an analyzer...
config Set or view config variables
connector-healthcheck Send healthcheck request for a connector
jobs Manage Jobs
tags Manage tags
```### As a library / SDK
```python
from pyintelowl import IntelOwl
obj = IntelOwl("", "", "optional", "optional")
```For more comprehensive documentation, please see https://intelowlproject.github.io/docs/pyintelowl/.
## Changelog
View [CHANGELOG.md](https://github.com/intelowlproject/pyintelowl/blob/master/.github/CHANGELOG.md).
## How to generate an API key
You need a valid API key to interact with the IntelOwl server.
Keys can be created from the "API access" section of the user's menu in the IntelOwl's GUI.
Otherwise, you can create them from the Django Admin Interface of the IntelOwl application with an administration account. Section "Durin" -> "Auth tokens"