Skip to main content

PyIntelOwl

PyPI version PyPI Supported Python Versions

Pull request automation codecov CodeFactor

Robust Python SDK and Command Line Client for interacting with 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

pyintelowl asciicast

Installation

$ 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,

$ 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

from pyintelowl import IntelOwl
obj = IntelOwl("<your_api_key>", "<your_intelowl_instance_url>", "optional<path_to_pem_file>", "optional<proxies>")

For more comprehensive documentation, please see https://intelowlproject.github.io/docs/pyintelowl/.

Changelog

View 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.

api_access

Otherwise, you can create them from the Django Admin Interface of the IntelOwl application with an administration account. Section "Durin" -> "Auth tokens"

Metadata

Release files for pyintelowl 5.1.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for pyintelowl 5.1.0
File Size Uploaded
pyintelowl-5.1.0.tar.gz 46.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for pyintelowl 5.1.0
File Interpreter ABI Platform
pyintelowl-5.1.0-py3-none-any.whl Python 3 none any Details

Total release size: 97.1 kB

Release files / pyintelowl-5.1.0.tar.gz

Download URL pyintelowl-5.1.0.tar.gz
Size 46.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4b5dd1e39ac54b1bbb3fa5aafc41e322b4058678a49fe6ff095be87e2c071353
BLAKE2b-256 checksum
How to use checksums
b625d5af65a9581e86c026e47c22a1d17676e3b6742071c3e28c9f51717c46a6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Release files / pyintelowl-5.1.0-py3-none-any.whl

Download URL pyintelowl-5.1.0-py3-none-any.whl
Size 51.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
759f685e37974cd69b943d48ee53b52a8a61234a96bb78f6fd5bcc94e0f06919
BLAKE2b-256 checksum
How to use checksums
01be1a84743307e43b0fc89b095cffa1953e705f045e235579b92479aed695c5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/5.1.1 CPython/3.12.7

Release history Release notifications | RSS feed

This release

5.1.0 This release

2 release files

5.0.2

2 release files

5.0.1

2 release files

5.0.0

2 release files

4.4.7

2 release files

4.4.6

2 release files

4.4.5

2 release files

4.4.4

2 release files

4.4.3

2 release files

4.4.2

2 release files

4.4.1

2 release files

4.4.0

2 release files

4.3.0

2 release files

4.2.0

2 release files

4.1.5

2 release files

4.1.4

2 release files

4.1.3

2 release files

4.1.2

2 release files

4.1.1

2 release files

4.1.0

2 release files

4.0.0

2 release files

3.1.4

2 release files

3.1.3

2 release files

3.1.2

2 release files

3.1.1

2 release files

3.1.0

2 release files

3.0.1

2 release files

3.0.0

2 release files

2.0.0

2 release files

1.3.5

2 release files

1.3.4

2 release files

1.3.2

2 release files

1.3.1

2 release files

1.3.0

2 release files

1.2.0

2 release files

1.1.0

2 release files

1.0.0

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.2

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page