Skip to main content

A Python wrapper for

Project description


A Python module for using the API.

Installing / Upgrading

$ pip install -U PyScanii


>>> 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.
{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

# .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

>>> pyscanii.files[0].findings

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

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

>>> pyscanii.files[0].infected

>>> 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


Version 1.1.3 - 06 April 2016

  • First production version.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for PyScanii, version 1.1.4
Filename, size File type Python version Upload date Hashes
Filename, size PyScanii-1.1.4.tar.gz (3.7 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page