Skip to main content

A Python wrapper around clamd, the ClamAV daemon

Project description

clamdpy

A Python wrapper around clamd, the ClamAV daemon.

This is a maintained and updated fork of https://github.com/graingert/python-clamd/, credit goes to the original developer(s).

Python versions PyPI version Code style: Black Ruff

Installation

Using pip:

pip install clamdpy

Usage

from io import BytesIO

from clamdpy import ClamdNetworkSocket

clamd = ClamdNetworkSocket(
    host="127.0.0.1",
    port=3310,
    timeout=15,
)

clamd.ping()
#> 'PONG'

clamd.version()
#> VersionInfo(version='ClamAV 0.103.9', signature=27065, signature_date=datetime(2023, 10, 18, 9, 49, 14))

# Raw response can be fetched as well:
clamd.version(raw=True)
#> 'ClamAV 0.103.9/27065/Wed Oct 18 09:49:14 2023'

clamd.instream(BytesIO(b"data"))
#> ScanResult(path='stream', reason=None, status='OK')

Most of the clamd commands are implemented (a couple ones are missing and should be implemented sooner or later).

It is possible to use UNIX sockets as well:

from clamdpy import ClamdUnixSocket

clamd = ClamdUnixSocket(path="/var/run/clamav/clamd.ctl")

Line delimitations

By default, \n will be used to terminate lines. Clamd also supports NULL characters:

from clamdpy import ClamdNetworkSocket

clamd = ClamdNetworkSocket(line_terminator="z")

[!WARNING]
Support for the NULL character isn't tested and may not work as it doesn't play well with Python. Use with caution.

Project details


Download files

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

Source Distribution

clamdpy-0.1.0.post1.tar.gz (10.5 kB view hashes)

Uploaded Source

Built Distribution

clamdpy-0.1.0.post1-py3-none-any.whl (8.5 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page