<h1 align="center">
<sub>
<img src="https://raw.githubusercontent.com/maxmmueller/virustotalpy/master/imgs/vt_logo.jpeg" height="30">
</sub>
VirusTotalPy
</h1>
<p align="center">
<img src="https://img.shields.io/pypi/v/virustotalpy.svg?style=square">
<img src="https://img.shields.io/badge/license-Apache%202-blue">
<a href="https://github.com/maxmmueller/virustotalpy/blob/main/LICENSE"></a>
</p>
<p align="center">Open-source Python library for an easier interaction with the VirusTotal v3 API</p>
## Features
The latest Version 1.0.1 lets you analyse and scan a list of IPs, URLs and files up to 650MB.
## Installation
##### Method 1:
<a href="https://www.python.org/downloads/"><img src="https://img.shields.io/badge/Requires-Python%203.6%20(or%20newer)-blue"/></a>
```
pip install virustotalpy
```
##### Method 2:
<a href="https://git-scm.com/downloads"><img src="https://img.shields.io/badge/Requires-git-blue"/></a>
```
git clone https://github.com/maxmmueller/virustotalpy.git
```
##### Method 3:
Download the [latest Release](https://github.com/maxmmueller/virustotalpy/releases/latest)
## Usage
In order to use the API you need to [sign up](https://www.virustotal.com/gui/join-us) for a VirusTotal account and create an API key.
>
> 
Code example:
```python
from virustotalpy import Scanner
# replace this with your actual api key and username
API_KEY = "YOUR-API-KEY"
USER_NAME = "YOUR-VIRUSTOTAL-USERNAME"
scanner = Scanner(API_KEY, USER_NAME)
data = [
"https://www.example.com",
"192.168.0.1",
"test.exe"
]
result = scanner.scan(data)
print(result)
```
## Learn more
- [Documentation and reference](https://github.com/maxmmueller/virustotalpy/blob/main/docs/docs.md)
- [PyPI](https://pypi.org/project/virustotalpy)
- [API reference](https://developers.virustotal.com/reference/overview)
## Contributing
Contributions to this project are welcome!
If you encounter any problems, find a bug or have feature requests, please open an [issue](https://github.com/maxmmueller/virustotalpy/issues/new).
## Licence
Maximilian Müller 2021-2023
[Apache License 2.0](LICENSE)
Raw data
{
"_id": null,
"home_page": "https://github.com/maxmmueller/virustotalpy",
"name": "virustotalpy",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Maximilian M\u00fcller",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/5f/ae/6f85ed4b6d5e28c35a7f3ff78cdfc28263d0a37b8c4ded809a8bb34ba692/virustotalpy-1.0.1.tar.gz",
"platform": null,
"description": "<h1 align=\"center\">\n<sub>\n<img src=\"https://raw.githubusercontent.com/maxmmueller/virustotalpy/master/imgs/vt_logo.jpeg\" height=\"30\">\n</sub>\nVirusTotalPy\n</h1>\n\n<p align=\"center\">\n<img src=\"https://img.shields.io/pypi/v/virustotalpy.svg?style=square\">\n<img src=\"https://img.shields.io/badge/license-Apache%202-blue\">\n<a href=\"https://github.com/maxmmueller/virustotalpy/blob/main/LICENSE\"></a>\n</p>\n\n<p align=\"center\">Open-source Python library for an easier interaction with the VirusTotal v3 API</p>\n\n\n## Features\nThe latest Version 1.0.1 lets you analyse and scan a list of IPs, URLs and files up to 650MB.\n\n## Installation\n##### Method 1:\n<a href=\"https://www.python.org/downloads/\"><img src=\"https://img.shields.io/badge/Requires-Python%203.6%20(or%20newer)-blue\"/></a>\n```\npip install virustotalpy\n```\n\n##### Method 2:\n <a href=\"https://git-scm.com/downloads\"><img src=\"https://img.shields.io/badge/Requires-git-blue\"/></a>\n\n```\ngit clone https://github.com/maxmmueller/virustotalpy.git\n```\n\n##### Method 3:\nDownload the [latest Release](https://github.com/maxmmueller/virustotalpy/releases/latest)\n\n\n## Usage\nIn order to use the API you need to [sign up](https://www.virustotal.com/gui/join-us) for a VirusTotal account and create an API key.\n>\n> \n\nCode example:\n```python\nfrom virustotalpy import Scanner\n\n# replace this with your actual api key and username\nAPI_KEY = \"YOUR-API-KEY\"\nUSER_NAME = \"YOUR-VIRUSTOTAL-USERNAME\"\n\nscanner = Scanner(API_KEY, USER_NAME)\n\ndata = [\n \"https://www.example.com\",\n \"192.168.0.1\",\n \"test.exe\"\n]\n\nresult = scanner.scan(data)\nprint(result)\n```\n\n## Learn more\n\n- [Documentation and reference](https://github.com/maxmmueller/virustotalpy/blob/main/docs/docs.md)\n- [PyPI](https://pypi.org/project/virustotalpy)\n- [API reference](https://developers.virustotal.com/reference/overview)\n\n## Contributing\nContributions to this project are welcome!\n\nIf you encounter any problems, find a bug or have feature requests, please open an [issue](https://github.com/maxmmueller/virustotalpy/issues/new).\n\n## Licence\nMaximilian M\u00fcller 2021-2023\n[Apache License 2.0](LICENSE)\n\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "library for an easier interaction with the VirusTotal v3 API",
"version": "1.0.1",
"project_urls": {
"Homepage": "https://github.com/maxmmueller/virustotalpy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc248169e14fa99ea6d0375665d8a556abea2dd5b7308df0ec038a26bdb16d8c",
"md5": "715539f661827b104351544784e6b124",
"sha256": "2ca8448db90c770447e0f32b6e9dd5174f6d77d72c9948e40cea66b3a12d7ef1"
},
"downloads": -1,
"filename": "virustotalpy-1.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "715539f661827b104351544784e6b124",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 8585,
"upload_time": "2023-06-06T11:01:37",
"upload_time_iso_8601": "2023-06-06T11:01:37.647465Z",
"url": "https://files.pythonhosted.org/packages/dc/24/8169e14fa99ea6d0375665d8a556abea2dd5b7308df0ec038a26bdb16d8c/virustotalpy-1.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5fae6f85ed4b6d5e28c35a7f3ff78cdfc28263d0a37b8c4ded809a8bb34ba692",
"md5": "52ff1435336fd8906d092349d8e53cf4",
"sha256": "1bd6166ba2b36a322b9af72fd482557dac8cd4ecfc73dc91085eed19c0b3b8a4"
},
"downloads": -1,
"filename": "virustotalpy-1.0.1.tar.gz",
"has_sig": false,
"md5_digest": "52ff1435336fd8906d092349d8e53cf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 4283,
"upload_time": "2023-06-06T11:01:39",
"upload_time_iso_8601": "2023-06-06T11:01:39.539058Z",
"url": "https://files.pythonhosted.org/packages/5f/ae/6f85ed4b6d5e28c35a7f3ff78cdfc28263d0a37b8c4ded809a8bb34ba692/virustotalpy-1.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-06 11:01:39",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "maxmmueller",
"github_project": "virustotalpy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "virustotalpy"
}
JSON
