{"id":20216659,"url":"https://github.com/intelowlproject/pyintelowl","last_synced_at":"2025-05-16T14:04:31.769Z","repository":{"id":36983899,"uuid":"218579196","full_name":"intelowlproject/pyintelowl","owner":"intelowlproject","description":"Robust Python SDK and Command Line Client for interacting with IntelOwl's API.","archived":false,"fork":false,"pushed_at":"2025-04-01T02:47:42.000Z","size":4044,"stargazers_count":68,"open_issues_count":11,"forks_count":26,"subscribers_count":7,"default_branch":"master","last_synced_at":"2025-05-07T17:31:05.678Z","etag":null,"topics":["analysis","cli","click","intel-owl","intelowl-api","intelowl-sdk","intelowl-server","rich","sdk"],"latest_commit_sha":null,"homepage":"https://pyintelowl.readthedocs.io","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/intelowlproject.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2019-10-30T17:00:17.000Z","updated_at":"2025-04-19T19:54:08.000Z","dependencies_parsed_at":"2023-02-12T20:01:22.537Z","dependency_job_id":"622b012f-eefd-4646-ac61-78b22be507fb","html_url":"https://github.com/intelowlproject/pyintelowl","commit_stats":{"total_commits":246,"total_committers":15,"mean_commits":16.4,"dds":0.6788617886178862,"last_synced_commit":"ba3a23650e156e512e658f0ad693a1f849f159f1"},"previous_names":[],"tags_count":43,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intelowlproject%2Fpyintelowl","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intelowlproject%2Fpyintelowl/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intelowlproject%2Fpyintelowl/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/intelowlproject%2Fpyintelowl/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/intelowlproject","download_url":"https://codeload.github.com/intelowlproject/pyintelowl/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254536699,"owners_count":22087559,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["analysis","cli","click","intel-owl","intelowl-api","intelowl-sdk","intelowl-server","rich","sdk"],"created_at":"2024-11-14T06:29:09.986Z","updated_at":"2025-05-16T14:04:31.751Z","avatar_url":"https://github.com/intelowlproject.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 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\n[![Pull request automation](https://github.com/intelowlproject/pyintelowl/actions/workflows/pull_request_automation.yml/badge.svg)](https://github.com/intelowlproject/pyintelowl/actions/workflows/pull_request_automation.yml)\n[![codecov](https://codecov.io/gh/intelowlproject/pyintelowl/branch/master/graph/badge.svg?token=JF62UMZ0U6)](https://codecov.io/gh/intelowlproject/pyintelowl)\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\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  analyzer-healthcheck   Send healthcheck request for an analyzer...\n  config                 Set or view config variables\n  connector-healthcheck  Send healthcheck request for a connector\n  jobs                   Manage Jobs\n  tags                   Manage tags\n```\n\n### As a library / SDK\n\n```python\nfrom pyintelowl import IntelOwl\nobj = IntelOwl(\"\u003cyour_api_key\u003e\", \"\u003cyour_intelowl_instance_url\u003e\", \"optional\u003cpath_to_pem_file\u003e\", \"optional\u003cproxies\u003e\")\n```\n\nFor more comprehensive documentation, please see https://intelowlproject.github.io/docs/pyintelowl/.\n\n## Changelog\n\nView [CHANGELOG.md](https://github.com/intelowlproject/pyintelowl/blob/master/.github/CHANGELOG.md).\n\n\n## How to generate an API key\n\nYou need a valid API key to interact with the IntelOwl server.\nKeys can be created from the \"API access\" section of the user's menu in the IntelOwl's GUI.\n\n![api_access](static/api_access.png)\n\nOtherwise, you can create them from the Django Admin Interface of the IntelOwl application with an administration account. Section \"Durin\" -\u003e \"Auth tokens\"\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintelowlproject%2Fpyintelowl","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fintelowlproject%2Fpyintelowl","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fintelowlproject%2Fpyintelowl/lists"}