pyintelowl


Namepyintelowl JSON
Version 3.1.3 PyPI version JSON
download
home_pagehttps://github.com/intelowlproject/pyintelowl
SummaryRobust Python SDK and CLI for IntelOwl's API
upload_time2021-06-10 13:27:30
maintainer
docs_urlNone
authorMatteo Lodi
requires_python>=3.6
license
keywords intelowl sdk python command line osint threat intel malware
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # PyIntelOwl

[![PyPI version](https://badge.fury.io/py/pyintelowl.svg)](https://badge.fury.io/py/pyintelowl)
[![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyintelowl.svg)](https://pypi.python.org/pypi/pyintelowl/)
[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/intelowlproject/pyintelowl.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mlodic/pyintelowl/context:python)
[![CodeFactor](https://www.codefactor.io/repository/github/intelowlproject/pyintelowl/badge)](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.
- Tabular view of the `analyzer_config.json` from IntelOwl with RegEx matching capabilities.

## Demo

[![pyintelowl asciicast](https://asciinema.org/a/z7L93lsIzOQ0Scve7hMl30mJJ.svg)](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
  config               Set or view config variables
  get-analyzer-config  Get current state of `analyzer_config.json` from the...
  jobs                 Manage Jobs
  tags                 Manage tags
```

### As a library / SDK

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

For more comprehensive documentation, please see https://pyintelowl.readthedocs.io/.

## Changelog

View [CHANGELOG.md](https://github.com/intelowlproject/pyintelowl/blob/master/.github/CHANGELOG.md).

## FAQ

#### Generate API key
You need a valid API key to interact with the IntelOwl server. 
Keys should be created from the admin interface of [IntelOwl](https://github.com/intelowlproject/intelowl): you have to go in the *Durin* section (click on `Auth tokens`) and generate a key there.

#### Incompatibility after version 3.0

We did a complete rewrite of the PyIntelOwl client and CLI both for the version `3.0.0`. We very much recommend you to update to the latest version to enjoy all new features.

#### (old auth method) JWT Token Authentication
> this auth was available in IntelOwl versions <1.8.0 and pyintelowl versions <2.0.0

From the admin interface of IntelOwl, you have to go in the *Outstanding tokens* section and generate a token there.

You can use it by pasting it into the file [api_token.txt](api_token.txt).



            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/intelowlproject/pyintelowl",
    "name": "pyintelowl",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.6",
    "maintainer_email": "",
    "keywords": "intelowl sdk python command line osint threat intel malware",
    "author": "Matteo Lodi",
    "author_email": "",
    "download_url": "https://files.pythonhosted.org/packages/30/08/ff5e1c767fc8fc7feb4ddafe6833b0399ab8f333fd8eb52d157c5eec571d/pyintelowl-3.1.3.tar.gz",
    "platform": "",
    "description": "# PyIntelOwl\n\n[![PyPI version](https://badge.fury.io/py/pyintelowl.svg)](https://badge.fury.io/py/pyintelowl)\n[![PyPI Supported Python Versions](https://img.shields.io/pypi/pyversions/pyintelowl.svg)](https://pypi.python.org/pypi/pyintelowl/)\n[![Language grade: Python](https://img.shields.io/lgtm/grade/python/g/intelowlproject/pyintelowl.svg?logo=lgtm&logoWidth=18)](https://lgtm.com/projects/g/mlodic/pyintelowl/context:python)\n[![CodeFactor](https://www.codefactor.io/repository/github/intelowlproject/pyintelowl/badge)](https://www.codefactor.io/repository/github/intelowlproject/pyintelowl)\n\nRobust Python **SDK** and **Command Line Client** for interacting with [IntelOwl](https://github.com/intelowlproject/IntelOwl)'s API.\n\n## Features\n\n- Easy one-time configuration with self documented help and hints along the way.\n- Request new analysis for observables and files.\n  - Select which analyzers you want to run for every analysis you perform.\n  - Choose whether you want to HTTP poll for the analysis to finish or not.\n- List all jobs or view one job in a prettified tabular form.\n- List all tags or view one tag in a prettified tabular form.\n- Tabular view of the `analyzer_config.json` from IntelOwl with RegEx matching capabilities.\n\n## Demo\n\n[![pyintelowl asciicast](https://asciinema.org/a/z7L93lsIzOQ0Scve7hMl30mJJ.svg)](https://asciinema.org/a/z7L93lsIzOQ0Scve7hMl30mJJ?t=5)\n\n## Installation\n\n```bash\n$ pip3 install pyintelowl\n```\n\nFor development/testing, `pip3 install pyintelowl[dev]`\n\n## Quickstart\n\n### As Command Line Client\n\nOn successful installation, The `pyintelowl` entryscript should be directly invokable. For example,\n\n```bash\n$ pyintelowl\nUsage: pyintelowl [OPTIONS] COMMAND [ARGS]...\n\nOptions:\n  -d, --debug  Set log level to DEBUG\n  --version    Show the version and exit.\n  -h, --help   Show this message and exit.\n\nCommands:\n  analyse              Send new analysis request\n  config               Set or view config variables\n  get-analyzer-config  Get current state of `analyzer_config.json` from the...\n  jobs                 Manage Jobs\n  tags                 Manage tags\n```\n\n### As a library / SDK\n\n```python\nfrom pyintelowl import IntelOwl\nobj = IntelOwl(\"<your_api_key>\", \"<your_intelowl_instance_url>\", \"optional<path_to_pem_file>\")\n```\n\nFor more comprehensive documentation, please see https://pyintelowl.readthedocs.io/.\n\n## Changelog\n\nView [CHANGELOG.md](https://github.com/intelowlproject/pyintelowl/blob/master/.github/CHANGELOG.md).\n\n## FAQ\n\n#### Generate API key\nYou need a valid API key to interact with the IntelOwl server. \nKeys should be created from the admin interface of [IntelOwl](https://github.com/intelowlproject/intelowl): you have to go in the *Durin* section (click on `Auth tokens`) and generate a key there.\n\n#### Incompatibility after version 3.0\n\nWe did a complete rewrite of the PyIntelOwl client and CLI both for the version `3.0.0`. We very much recommend you to update to the latest version to enjoy all new features.\n\n#### (old auth method) JWT Token Authentication\n> this auth was available in IntelOwl versions <1.8.0 and pyintelowl versions <2.0.0\n\nFrom the admin interface of IntelOwl, you have to go in the *Outstanding tokens* section and generate a token there.\n\nYou can use it by pasting it into the file [api_token.txt](api_token.txt).\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "Robust Python SDK and CLI for IntelOwl's API",
    "version": "3.1.3",
    "split_keywords": [
        "intelowl",
        "sdk",
        "python",
        "command",
        "line",
        "osint",
        "threat",
        "intel",
        "malware"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "616c9cc689def9b1ea68a1a0a3cfc3d1",
                "sha256": "c185ac055fc2857a5cded1182f9f45cb0d85162499fda49041b759d8c84e3b01"
            },
            "downloads": -1,
            "filename": "pyintelowl-3.1.3-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "616c9cc689def9b1ea68a1a0a3cfc3d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.6",
            "size": 41280,
            "upload_time": "2021-06-10T13:27:28",
            "upload_time_iso_8601": "2021-06-10T13:27:28.977965Z",
            "url": "https://files.pythonhosted.org/packages/08/a1/3db8bbe37f19c410206d182513b3f1946dbfe42aca90525ce0b989586973/pyintelowl-3.1.3-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "2d1a85bc981ca43ad1edb6f38e95f9df",
                "sha256": "9e91e856b66196064a43b36567de5ce63ceb95c71dd7084ae97ad5b45c9e6271"
            },
            "downloads": -1,
            "filename": "pyintelowl-3.1.3.tar.gz",
            "has_sig": false,
            "md5_digest": "2d1a85bc981ca43ad1edb6f38e95f9df",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.6",
            "size": 38403,
            "upload_time": "2021-06-10T13:27:30",
            "upload_time_iso_8601": "2021-06-10T13:27:30.568801Z",
            "url": "https://files.pythonhosted.org/packages/30/08/ff5e1c767fc8fc7feb4ddafe6833b0399ab8f333fd8eb52d157c5eec571d/pyintelowl-3.1.3.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2021-06-10 13:27:30",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "github_user": null,
    "github_project": "intelowlproject",
    "error": "Could not fetch GitHub repository",
    "lcname": "pyintelowl"
}
        
Elapsed time: 0.30656s