Python library for the Scanii.com API
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
PyScanii
.gitignore
AUTHORS
CHANGES
LICENSE
README.md
README.rst
pypi.py
requirements.txt
setup.py

README.md

PyScanii

A Python module for using the scanii.com API.

Installing / Upgrading

$ pip install -U PyScanii

Usage

>>> from PyScanii import PyScanii
>>> pyscanii = PyScanii('SOMEAPIKEY', 'SECRET', verbose=True) # Verbose is good while integrating / debugging.

# You can ping to see if things are set up properly.
>>> pyscanii.ping()
{u'message': u'pong', u'key': u'SOMEAPIKEY'}

# There is a .test method that sends the EICAR test string.
# WARNING: Costs a scan credit.

>>> pyscanii.test()

# It will populate the files list like any other scan.
>>> pyscanii.files[0].infected
True

# .scan() is the main method.
# It can accept single strings or paths.
# It can also accept a list or tuple of either of those things.
>>> pyscanii.scan('X5O!P%@AP[4\\PZX54(P^)7CC)7}$EICAR-STANDARD-ANTIVIRUS-TEST-FILE!$H+H*')
# The files property contains a list of ScanFile instances:

>>> pyscanii.files[0]
(563ef4b7836060b3bb9d0cba3e6a5f84) string.bin - Infected: True - Findings: [u'av.eicar-test-signature']

>>> str(pyscanii.files[0])
'{"content_length": 68, "infected": true, "name": "string.bin", "content_type": "text/plain", "checksum": "3395856ce81f2b7382dee72602f798b642f14140", "metadata": {}, "id": "563ef4b7836060b3bb9d0cba3e6a5f84", "findings": ["av.eicar-test-signature"], "creation_date": "2016-04-05T14:57:35.989Z"}'

>>> pyscanii.files[0].infected
True

>>> pyscanii.files[0].findings
[u'av.eicar-test-signature']

# You can also, of course, scan file paths:

>>> pyscanii.scan('~/Desktop/IMG_0011.jpeg')

>>> pyscanii.files[0].infected
False

>>> pyscanii.files[0].findings
[]

# The last_file property is good when you've only scanned one file:
>>> pyscanii.last_file
(d0e6345ea2ceb9c1f260c8e249f933df) ~/Desktop/IMG_0011.jpeg - Infected: False - Findings: []

>>> pyscanii.last_file.infected
False