chore: adjusted README.md

chore: project name modified

chore: fixed tests

chore: on-push CI

chore: simplified CI with lightweight clamav image

chore: fixed test_version

chore: disclaimer and installation steps in README.md

chore: better usage example in README.md and test renamed

chore: better usage example

Author: sajidurrahman

.github/workflows/ci.yml

@@ -0,0 +1,87 @@
+name: CI
+
+on:
+  push:
+    branches: [main, master]
+  pull_request:
+    branches: [main, master]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.10", "3.11", "3.12"]
+
+    services:
+      clamav:
+        image: clamav/clamav:stable
+        ports:
+          - 3310:3310
+        env:
+          CLAMAV_NO_FRESHCLAMD: "true"
+          CLAMAV_NO_MILTERD: "true"
+        options: >-
+          --health-cmd="echo PING | nc localhost 3310 | grep -q PONG"
+          --health-interval=30s
+          --health-timeout=30s
+          --health-retries=30
+          --health-start-period=300s
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install pytest
+          pip install -e .
+
+      - name: Wait for ClamAV to be ready
+        run: |
+          echo "Waiting for ClamAV service..."
+          timeout=600
+          elapsed=0
+          while [ $elapsed -lt $timeout ]; do
+            if echo PING | nc -w 5 localhost 3310 2>/dev/null | grep -q PONG; then
+              echo "ClamAV is ready after ${elapsed}s!"
+              exit 0
+            fi
+            echo "Waiting... (${elapsed}s elapsed)"
+            sleep 15
+            elapsed=$((elapsed + 15))
+          done
+          echo "ClamAV failed to start within ${timeout}s"
+          docker ps -a
+          docker logs $(docker ps -aq --filter "ancestor=clamav/clamav:stable") || true
+          exit 1
+
+      - name: Run tests
+        run: |
+          pytest src/tests/ -v
+
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+
+      - name: Install linting tools
+        run: |
+          python -m pip install --upgrade pip
+          pip install ruff
+
+      - name: Run linter
+        run: |
+          ruff check src/
+

README.md

@@ -20,30 +20,37 @@ This is a fork of the original [python-clamd](https://github.com/graingert/pytho
 ## Installation
 
 ```bash
-pip install python-clamd-fork
+pip install git+https://github.com/userlike/python-clamd.git
 ```
 
 ## Usage
 
 ```python
 import clamd
+from io import BytesIO
 
-# Connect via Unix socket
-cd = clamd.ClamdUnixSocket()
-
-# Or connect via network
+# Connect via network
 cd = clamd.ClamdNetworkSocket(host='127.0.0.1', port=3310)
 
 # Ping the daemon
-cd.ping()
+cd.ping() # Returns "PONG", otherwise raises ConnectionError or ResponseError
+
+# Scan content using instream (recommended - works with remote ClamAV)
+result = cd.instream(BytesIO(b'file content here'))
+# Returns: {'stream': ('OK', None)} for clean files
+# Returns: {'stream': ('FOUND', 'VirusName')} for infected files
 
-# Scan a file
+# Scan a file by path (only works if ClamAV can access the path)
 cd.scan('/path/to/file')
 
 # Get version info
 cd.version()
 ```
 
+## Disclaimer
+
+**USE AT YOUR OWN RISK.** This software is provided "as is", without warranty of any kind, express or implied. The authors and maintainers do not guarantee the correctness, reliability, or functionality of this package. We shall not be held liable for any damages, losses, or consequences arising from the use of this software. Please review the source code before using it in any production or critical environment.
+
 ## License
 
 LGPL - See the original [python-clamd](https://github.com/graingert/python-clamd) for details.

pyproject.toml

@@ -1,5 +1,5 @@
 [project]
-name = "python-clamd-fork"
+name = "clamd"
 version = "0.1.0"
 description = "It is a fork of https://github.com/graingert/python-clamd. It was forked to cleanup some deprecated code."
 readme = "README.md"

src/tests/test_api.py

@@ -1,87 +1,46 @@
-#!/usr/bin/env python
-# -*- coding: utf-8 -*-
-from __future__ import unicode_literals
 import clamd
 from io import BytesIO
-from contextlib import contextmanager
-import tempfile
-import shutil
-import os
-import stat
 
 import pytest
 
-mine = (stat.S_IREAD | stat.S_IWRITE)
-other = stat.S_IROTH
-execute = (stat.S_IEXEC | stat.S_IXOTH)
 
-
-@contextmanager
-def mkdtemp(*args, **kwargs):
-    temp_dir = tempfile.mkdtemp(*args, **kwargs)
-    try:
-        yield temp_dir
-    finally:
-        shutil.rmtree(temp_dir)
-
-
-class TestUnixSocket(object):
+class TestNetworkSocket(object):
+    """
+    Test suite expects ClamAV running at default host and port (localhost, 3310)
+    """
     kwargs = {}
 
+    @pytest.fixture(autouse=True)
     def setup(self):
-        self.cd = clamd.ClamdUnixSocket(**self.kwargs)
+        self.cd = clamd.ClamdNetworkSocket(**self.kwargs)
 
     def test_ping(self):
-        assert self.cd.ping()
+        result = self.cd.ping()
+        assert result == "PONG"
 
     def test_version(self):
-        assert self.cd.version().startswith("ClamAV")
+        version = self.cd.version()
+        assert "ClamAV 1.5.1" in version
 
     def test_reload(self):
         assert self.cd.reload() == 'RELOADING'
 
-    def test_scan(self):
-        with tempfile.NamedTemporaryFile('wb', prefix="python-clamd") as f:
-            f.write(clamd.EICAR)
-            f.flush()
-            os.fchmod(f.fileno(), (mine | other))
-            expected = {f.name: ('FOUND', 'Eicar-Test-Signature')}
-
-            assert self.cd.scan(f.name) == expected
-
-    def test_unicode_scan(self):
-        with tempfile.NamedTemporaryFile('wb', prefix=u"python-clamdλ") as f:
-            f.write(clamd.EICAR)
-            f.flush()
-            os.fchmod(f.fileno(), (mine | other))
-            expected = {f.name: ('FOUND', 'Eicar-Test-Signature')}
 
-            assert self.cd.scan(f.name) == expected
-
-    def test_multiscan(self):
-        expected = {}
-        with mkdtemp(prefix="python-clamd") as d:
-            for i in range(10):
-                with open(os.path.join(d, "file" + str(i)), 'wb') as f:
-                    f.write(clamd.EICAR)
-                    os.fchmod(f.fileno(), (mine | other))
-                    expected[f.name] = ('FOUND', 'Eicar-Test-Signature')
-            os.chmod(d, (mine | other | execute))
-
-            assert self.cd.multiscan(d) == expected
-
-    def test_instream(self):
+    def test_instream_found(self):
+        # Case: True positive
         expected = {'stream': ('FOUND', 'Eicar-Test-Signature')}
         assert self.cd.instream(BytesIO(clamd.EICAR)) == expected
 
-    def test_insteam_success(self):
+
+    def test_instream_ok(self):
+        # Case True negative
         assert self.cd.instream(BytesIO(b"foo")) == {'stream': ('OK', None)}
 
 
-class TestUnixSocketTimeout(TestUnixSocket):
+class TestUnixSocketTimeout(TestNetworkSocket):
     kwargs = {"timeout": 20}
 
 
 def test_cannot_connect():
     with pytest.raises(clamd.ConnectionError):
-        clamd.ClamdUnixSocket(path="/tmp/404").ping()
+        clamd.ClamdNetworkSocket(host="another_host").ping()