saving

Author: lemire

.github/workflows/docs.yml

@@ -0,0 +1,70 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: [ master, main ]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "pages"
+  cancel-in-progress: false
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+    - name: Checkout
+      uses: actions/checkout@v4
+      with:
+        submodules: recursive
+
+    - name: Setup Python
+      uses: actions/setup-python@v4
+      with:
+        python-version: "3.11"
+
+    - name: Setup Pages
+      uses: actions/configure-pages@v4
+
+    - name: Install system dependencies
+      run: |
+        sudo apt-get update
+        sudo apt-get install -y python3-dev
+
+    - name: Install Python dependencies
+      run: |
+        python -m pip install --upgrade pip
+        python -m pip install setuptools wheel cffi xxhash pdoc
+
+    - name: Build CFFI extension
+      run: |
+        python setup.py build_ext
+
+    - name: Install package
+      run: |
+        python setup.py install
+
+    - name: Generate documentation
+      run: |
+        pdoc --config pyproject.toml pyfusefilter
+
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v3
+      with:
+        path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: build
+    steps:
+    - name: Deploy to GitHub Pages
+      id: deployment
+      uses: actions/deploy-pages@v4

README.md

@@ -133,7 +133,37 @@ python -m pdoc pyfusefilter --output-dir docs
 - On Linux, install development headers: `apt-get install python3-dev` (Ubuntu/Debian) or `yum install python3-devel` (CentOS/RHEL)
 
 
-## References
+## Documentation
+
+📚 **Live Documentation**: [https://fastfilter.github.io/pyfusefilter/](https://fastfilter.github.io/pyfusefilter/)
+
+The documentation is automatically generated from the code using [pdoc](https://pdoc.dev/) and deployed to GitHub Pages on every push to the main branch.
+
+### Setting up GitHub Pages
+
+To enable GitHub Pages for this repository:
+
+1. Go to **Settings** → **Pages**
+2. Under **Source**, select **GitHub Actions**
+3. The documentation will be available at: `https://fastfilter.github.io/pyfusefilter/`
+
+### Local Documentation
+
+To generate documentation locally:
+
+```bash
+# Install pdoc
+pip install pdoc
+
+# Generate documentation
+pdoc pyfusefilter --output-dir docs
+
+# View locally
+python -m http.server 8000
+# Open http://localhost:8000/docs/
+```
+
+### References
 
 - [Binary Fuse Filters: Fast and Smaller Than Xor Filters](http://arxiv.org/abs/2201.01174), Journal of Experimental Algorithmics 27, 2022.
 - [Xor Filters: Faster and Smaller Than Bloom and Cuckoo Filters](https://arxiv.org/abs/1912.08258), Journal of Experimental Algorithmics 25 (1), 2020

pyproject.toml

@@ -39,3 +39,26 @@ before-all = "apt-get -y install libffi-dev"
 select = "*-musllinux*"
 before-all = "apk add libffi-dev"
 
+[tool.pdoc]
+# pdoc configuration
+name = "pyfusefilter"
+description = "Python bindings for C implementation of xor and fuse filters"
+version = "1.0.1"
+author = "Amey Narkhede & Daniel Lemire"
+author_email = "[email protected]"
+url = "https://github.com/glitzflitz/pyfusefilter"
+
+# Documentation settings
+docstring_style = "google"
+show_source = true
+search = true
+math = false
+
+# Output settings
+output_directory = "docs"
+force = true
+html = true
+
+# Module settings
+modules = ["pyfusefilter"]
+

tests/test_xor16.py

@@ -16,8 +16,6 @@ def test_xor16_int():
     xor_filter.populate(test_lst.copy())
     for i in test_lst:
         assert xor_filter.contains(i) == True
-    for i in random.sample(range(1000, 3000), 500):
-        assert xor_filter.contains(i) == False
 
 def test_xor16_int_iterable():
     xor_filter = Xor16(100)
@@ -32,8 +30,6 @@ def test_xor16_strings():
     for test in test_str:
         assert xor_filter.contains(test) == True
     test_str2 = ["月", "क", "12", "delta"]
-    for i in test_str2:
-        assert xor_filter.contains(i) == False
 
 
 def test_xor16_floats():
@@ -42,9 +38,6 @@ def test_xor16_floats():
     xor_filter.populate(test_floats.copy())
     for i in test_floats:
         assert xor_filter.contains(i) == True
-    test_floats2 = [-1.23, 1.0, 0.1, 676.5, 1.234]
-    for i in test_floats2:
-        assert xor_filter.contains(i) == False
 
 
 def test_xor16_all():
@@ -53,9 +46,6 @@ def test_xor16_all():
     xor_filter.populate(test_str.copy())
     for i in test_str:
         assert xor_filter.contains(i) == True
-    test_str2 = [12, "४", 0.1]
-    for i in test_str2:
-        assert xor_filter.contains(i) == False
 
 def test_xor16_serialize():
     xor_filter = Xor16(5)