clamd
=====
.. image:: https://travis-ci.org/graingert/python-clamd.png?branch=master
:alt: travis build status
:target: https://travis-ci.org/graingert/python-clamd
About
-----
`clamd` is a portable Python module to use the ClamAV anti-virus engine on
Windows, Linux, MacOSX and other platforms. It requires a running instance of
the `clamd` daemon.
This is a fork of pyClamd v0.2.0 created by Philippe Lagadec and published on his website: http://www.decalage.info/en/python/pyclamd which in turn is a slightly improved version of pyClamd v0.1.1 created by Alexandre Norman and published on his website: http://xael.org/norman/python/pyclamd/
Usage
-----
To use with a unix socket::
>>> import clamd
>>> cd = clamd.ClamdUnixSocket()
>>> cd.ping()
'PONG'
>>> cd.version() # doctest: +ELLIPSIS
'ClamAV ...
>>> cd.reload()
'RELOADING'
To scan a file::
>>> open('/tmp/EICAR','wb').write(clamd.EICAR)
>>> cd.scan('/tmp/EICAR')
{'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')}
To scan a stream::
>>> from six import BytesIO
>>> cd.instream(BytesIO(clamd.EICAR))
{'stream': ('FOUND', 'Eicar-Test-Signature')}
License
-------
`clamd` is released as open-source software under the LGPL license.
clamd Install
-------------
How to install the ClamAV daemon `clamd` under Ubuntu::
sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs
sudo freshclam
sudo service clamav-daemon start
Changes
=========
1.0.2 (2014-08-21)
------------------
- Remove all dependencies. clamd is now standalone!
- Use plain setuptools no d2to1.
- Create universal wheel.
1.0.1 (2013-03-06)
------------------
- Updated d2to1 dependency
1.0.0 (2013-02-08)
------------------
- Change public interface, including exceptions
- Support Python 3.3, withdraw 2.5 support
0.3.4 (2013-02-01)
------------------
- Use regex to parse file status reponse instead of complicated string split/join
0.3.3 (2013-01-28)
------------------
- First version of clamd that can be installed from PyPI
Raw data
{
"_id": null,
"home_page": "https://github.com/graingert/python-clamd",
"name": "clamd",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "python,clamav,antivirus,scanner,virus,libclamav,clamd",
"author": "Thomas Grainger",
"author_email": "python-clamd@graingert.co.uk",
"download_url": "https://files.pythonhosted.org/packages/14/8b/55332f1f79f28a5ccc50f66364087e64fae8e4ed62e52007ca82b3072221/clamd-1.0.2.tar.gz",
"platform": "UNKNOWN",
"description": "clamd\n=====\n\n.. image:: https://travis-ci.org/graingert/python-clamd.png?branch=master\n :alt: travis build status\n :target: https://travis-ci.org/graingert/python-clamd\n\nAbout\n-----\n`clamd` is a portable Python module to use the ClamAV anti-virus engine on \nWindows, Linux, MacOSX and other platforms. It requires a running instance of \nthe `clamd` daemon.\n\nThis is a fork of pyClamd v0.2.0 created by Philippe Lagadec and published on his website: http://www.decalage.info/en/python/pyclamd which in turn is a slightly improved version of pyClamd v0.1.1 created by Alexandre Norman and published on his website: http://xael.org/norman/python/pyclamd/\n\nUsage\n-----\n\nTo use with a unix socket::\n\n >>> import clamd\n >>> cd = clamd.ClamdUnixSocket()\n >>> cd.ping()\n 'PONG'\n >>> cd.version() # doctest: +ELLIPSIS\n 'ClamAV ...\n >>> cd.reload()\n 'RELOADING'\n\nTo scan a file::\n\n >>> open('/tmp/EICAR','wb').write(clamd.EICAR)\n >>> cd.scan('/tmp/EICAR')\n {'/tmp/EICAR': ('FOUND', 'Eicar-Test-Signature')}\n\nTo scan a stream::\n\n >>> from six import BytesIO\n >>> cd.instream(BytesIO(clamd.EICAR))\n {'stream': ('FOUND', 'Eicar-Test-Signature')}\n\n\nLicense\n-------\n`clamd` is released as open-source software under the LGPL license.\n\nclamd Install\n-------------\nHow to install the ClamAV daemon `clamd` under Ubuntu::\n\n sudo apt-get install clamav-daemon clamav-freshclam clamav-unofficial-sigs\n sudo freshclam\n sudo service clamav-daemon start\n\n\nChanges\n=========\n\n1.0.2 (2014-08-21)\n------------------\n\n- Remove all dependencies. clamd is now standalone!\n- Use plain setuptools no d2to1.\n- Create universal wheel.\n\n\n1.0.1 (2013-03-06)\n------------------\n\n- Updated d2to1 dependency\n\n\n1.0.0 (2013-02-08)\n------------------\n\n- Change public interface, including exceptions\n- Support Python 3.3, withdraw 2.5 support\n\n\n0.3.4 (2013-02-01)\n------------------\n\n- Use regex to parse file status reponse instead of complicated string split/join\n\n\n0.3.3 (2013-01-28)\n------------------\n\n- First version of clamd that can be installed from PyPI",
"bugtrack_url": null,
"license": "UNKNOWN",
"summary": "Clamd is a python interface to Clamd (Clamav daemon).",
"version": "1.0.2",
"project_urls": {
"Download": "UNKNOWN",
"Homepage": "https://github.com/graingert/python-clamd"
},
"split_keywords": [
"python",
"clamav",
"antivirus",
"scanner",
"virus",
"libclamav",
"clamd"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3dd084614de2a53ad52370adc9f9260bea420e53e0c228a248ec0eacfa65ccbb",
"md5": "355f5210a2a4096a3fd88aeb9e41630c",
"sha256": "5c32546b7d1eb00fd6be00a889d79e00fbf980ed082826ccfa369bce3dcff5e7"
},
"downloads": -1,
"filename": "clamd-1.0.2-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "355f5210a2a4096a3fd88aeb9e41630c",
"packagetype": "bdist_wheel",
"python_version": "2.7",
"requires_python": null,
"size": 6684,
"upload_time": "2014-08-21T14:58:22",
"upload_time_iso_8601": "2014-08-21T14:58:22.946918Z",
"url": "https://files.pythonhosted.org/packages/3d/d0/84614de2a53ad52370adc9f9260bea420e53e0c228a248ec0eacfa65ccbb/clamd-1.0.2-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "148b55332f1f79f28a5ccc50f66364087e64fae8e4ed62e52007ca82b3072221",
"md5": "637f1d44a60a511544b6bd0bcb817f8a",
"sha256": "d82a2fd814684a35a1b31feadafb2e69c8ebde9403613f6bdaa5d877c0f29560"
},
"downloads": -1,
"filename": "clamd-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "637f1d44a60a511544b6bd0bcb817f8a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8218,
"upload_time": "2014-08-21T14:58:18",
"upload_time_iso_8601": "2014-08-21T14:58:18.562784Z",
"url": "https://files.pythonhosted.org/packages/14/8b/55332f1f79f28a5ccc50f66364087e64fae8e4ed62e52007ca82b3072221/clamd-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2014-08-21 14:58:18",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "graingert",
"github_project": "python-clamd",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "clamd"
}
JSON
