<commit_before>VirustotalAPI
-------------
The python library that implement Virustotal public API 2.0

Dependency
----------
you need install python `requests` first

    pip install requests

Installation
------------
install by pip

    pip install vtapi

install by git

    cd /tmp
    git clone https://github.com/z-sean-huang/VirustotalAPI.git
    cd VirustotalAPI
    python setup.py install

uninstall

    pip uninstall vtapi


Usage
-----
after install vtapi:
```python
import vtapi

vt = vtapi.VtApi("PUT YOUR VIRUSTOTAL PUBLIC KEY HERE")
    
# rating for url
# you shold get return ('google.com', 0, 52)
# 0 and 52 means 0 virus detected number by 52 virus scan engines
# the higher the detected number, the more likely malicious it is.
print(vt.rating("google.com"))


# rating for file
# for the privacy sake, i don't send any file to virustotal
# just query if there is the same file in virustotal
# you should keep in mind don't send any secret files to virustotal.
print(vt.rating("/tmp/path/to/file"))

# rating by file's md5/sha1/sha256
# query by the hash, return none if there doesn't exist.
print(vt.rating("/tmp/path/to/file"))
```
<commit_msg>[vtapi] - fix typo<commit_after>VirustotalAPI
-------------
The python library that implement Virustotal public API 2.0

Dependency
----------
you need install python `requests` first

    pip install requests

Installation
------------
install by pip

    pip install vtapi

install by git

    cd /tmp
    git clone https://github.com/z-sean-huang/VirustotalAPI.git
    cd VirustotalAPI
    python setup.py install

uninstall

    pip uninstall vtapi


Usage
-----
after install vtapi:
```python
import vtapi

vt = vtapi.VtApi("PUT YOUR VIRUSTOTAL PUBLIC KEY HERE")
    
# rating for url
# you shold get return ('google.com', 0, 52)
# 0 and 52 means 0 virus detected number by 52 virus scan engines
# the higher the detected number, the more likely malicious it is.
print(vt.rating("google.com"))


# rating for file
# for the privacy sake, i don't send any file to virustotal
# just query if there is the same file in virustotal
# you should keep in mind don't send any secret files to virustotal.
print(vt.rating("/tmp/path/to/file"))

# rating by file's md5/sha1/sha256
# query by the hash, return none if there doesn't exist.
print(vt.rating("HASH_OF_FILE"))
```

{'fraction_non_alphanumeric': 0.10992301112061591, 'fraction_numerical': 0.013686911890504704, 'mean_word_length': 3.1992818671454217, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 2, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '6010842', 'n_tokens_mistral': 765, 'n_tokens_neox': 701, 'n_words': 292}