Metadata-Version: 2.1
Name: pyintelowl
Version: 3.0.0
Summary: Robust Python SDK and CLI for IntelOwl's API
Home-page: https://github.com/intelowlproject/pyintelowl
Author: Matteo Lodi
License: UNKNOWN
Project-URL: Documentation, https://github.com/intelowlproject/pyintelowl
Project-URL: Funding, https://liberapay.com/IntelOwlProject/
Project-URL: Source, https://github.com/intelowlproject/pyintelowl
Project-URL: Tracker, https://github.com/intelowlproject/pyintelowl/issues
Description: # PyIntelOwl
        
        [![PyPI version](https://badge.fury.io/py/pyintelowl.svg)](https://badge.fury.io/py/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.
        
        ## 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).
Keywords: intelowl sdk python command line osint threat intel
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Environment :: Web Environment
Classifier: License :: OSI Approved :: GNU Affero General Public License v3 or later (AGPLv3+)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.6
Description-Content-Type: text/markdown
Provides-Extra: dev
Provides-Extra: test
