Metadata-Version: 2.1
Name: virustotalpy
Version: 0.2.4
Summary: library for an easier interaction with the v3 api
Home-page: https://github.com/maxmmueller/virustotalpy
Author: Maximilian Müller
License: Apache License 2.0
Platform: UNKNOWN
Classifier: Intended Audience :: Developers
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
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: Programming Language :: Python :: 3.10
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
License-File: LICENSE

# virustotalpy
Virustotalpy is python library for an easier interaction with the public VirusTotal [v3 api](https://developers.virustotal.com/reference/overview). Virustotalpy v0.2.x let's you analyse and scan IPs, URLs and files up to 650MB.

## Installation
##### Method 1:
> Requires [Python](https://www.python.org/downloads/) 3.6 or newer.
```
pip install virustotalpy
```

##### Method 2:
> Requires [git](https://git-scm.com/downloads) 
```
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 get a VirusTotal api-key, you need to [sign up](https://www.virustotal.com/gui/join-us) for an account
>
> ![VirusTotal view API key](https://raw.githubusercontent.com/maxmmueller/virustotalpy/master/imgs/APIKey.jpeg)


At first the Virustotal class has to be initialised
```python
from virustotalpy import Virustotal

scanner = Virustotal('YOUR_API_KEY')
```
#### Files
- make api request
```python
resp = scanner.api_request('post', path='PATH_TO_FILE')
```
- Obtain information about the file:
> NOTE: To get this information, you have to use the "post" method first.

```python
resp = scanner.api_request('get', path='PATH_TO_FILE')
print(resp)
```

#### URLs

- make api request
```
resp = scanner.api_request('post', path='URL')
```
- Obtain information about the url:
> NOTE: To get this information, you have to use the "post" method first.

```python
resp = scanner.api_request('get', path='URL')
print(resp)
```

- more [examples](examples)

## Learn more

- [PyPI](https://pypi.org/project/virustotalpy)
- [API](https://developers.virustotal.com/reference/overview)

## License

Copyright Â© 2021-2022 Maximilian MÃ¼ller.
[Apache License 2.0](LICENSE).

