datasketch 1.7.0__tar.gz → 1.8.0__tar.gz

datasketch-1.8.0/.gitignore

@@ -0,0 +1,87 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+
+# C extensions
+*.so
+
+# VIM stuff
+*.swp
+
+# Distribution / packaging
+.Python
+env/
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+*.egg-info/
+.installed.cfg
+*.egg
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*,cover
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Documentation
+.doctrees
+_build
+doctrees
+
+# Jetbrains
+.idea
+
+# Benchmark files
+benchmark/**/*.inp.gz
+
+# Benchmark output
+benchmark/**/*.sqlite
+
+# Benchmark plots
+benchmark/**/*.png
+benchmark/**/*.pdf
+
+# Virtual env
+.venv
+
+# IDE
+.vscode
+
+# MacOS
+.DS_Store

{datasketch-1.7.0/datasketch.egg-info → datasketch-1.8.0}/PKG-INFO

@@ -1,67 +1,57 @@
 Metadata-Version: 2.4
 Name: datasketch
-Version: 1.7.0
+Version: 1.8.0
 Summary: Probabilistic data structures for processing and searching very large datasets
-Home-page: https://ekzhu.github.io/datasketch
-Author: ekzhu
-Author-email: ekzhu@cs.toronto.edu
-License: MIT
+Project-URL: Homepage, https://ekzhu.github.io/datasketch
+Project-URL: Bug Tracker, https://github.com/ekzhu/datasketch/issues
+Project-URL: Documentation, https://ekzhu.github.io/datasketch
 Project-URL: Source, https://github.com/ekzhu/datasketch
-Keywords: database datamining
+Author-email: ekzhu <ekzhu@cs.toronto.edu>
+License: MIT
+License-File: LICENSE
+Keywords: database,datamining
 Classifier: Development Status :: 5 - Production/Stable
 Classifier: Intended Audience :: Developers
-Classifier: Topic :: Database
-Classifier: Topic :: Scientific/Engineering :: Information Analysis
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
-License-File: LICENSE
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.9
 Requires-Dist: numpy>=1.11
 Requires-Dist: scipy>=1.0.0
+Provides-Extra: benchmark
+Requires-Dist: matplotlib>=3.1.2; extra == 'benchmark'
+Requires-Dist: nltk>=3.4.5; extra == 'benchmark'
+Requires-Dist: pandas>=0.25.3; extra == 'benchmark'
+Requires-Dist: pyfarmhash>=0.2.2; extra == 'benchmark'
+Requires-Dist: pyhash>=0.9.3; extra == 'benchmark'
+Requires-Dist: scikit-learn>=0.21.3; extra == 'benchmark'
+Requires-Dist: scipy>=1.3.3; extra == 'benchmark'
+Requires-Dist: setsimilaritysearch>=0.1.7; extra == 'benchmark'
+Provides-Extra: bloom
+Requires-Dist: pybloomfilter3>=0.7.2; extra == 'bloom'
 Provides-Extra: cassandra
-Requires-Dist: cassandra-driver>=3.20; extra == "cassandra"
+Requires-Dist: cassandra-driver>=3.20; extra == 'cassandra'
+Provides-Extra: experimental-aio
+Requires-Dist: aiounittest; extra == 'experimental-aio'
+Requires-Dist: motor>3.6.0; extra == 'experimental-aio'
 Provides-Extra: redis
-Requires-Dist: redis>=2.10.0; extra == "redis"
-Provides-Extra: bloom
-Requires-Dist: pybloomfilter3>=0.7.2; python_version >= "3.9" and extra == "bloom"
-Requires-Dist: pybloomfiltermmap3==0.6.0; python_version < "3.9" and extra == "bloom"
-Provides-Extra: benchmark
-Requires-Dist: pyhash>=0.9.3; extra == "benchmark"
-Requires-Dist: matplotlib>=3.1.2; extra == "benchmark"
-Requires-Dist: scikit-learn>=0.21.3; extra == "benchmark"
-Requires-Dist: scipy>=1.3.3; extra == "benchmark"
-Requires-Dist: pandas>=0.25.3; extra == "benchmark"
-Requires-Dist: SetSimilaritySearch>=0.1.7; extra == "benchmark"
-Requires-Dist: pyfarmhash>=0.2.2; extra == "benchmark"
-Requires-Dist: nltk>=3.4.5; extra == "benchmark"
+Requires-Dist: redis>=2.10.0; extra == 'redis'
 Provides-Extra: test
-Requires-Dist: cassandra-driver>=3.20; extra == "test"
-Requires-Dist: redis>=2.10.0; extra == "test"
-Requires-Dist: mock>=2.0.0; extra == "test"
-Requires-Dist: mockredispy; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: pymongo>=3.9.0; extra == "test"
-Requires-Dist: nose>=1.3.7; extra == "test"
-Requires-Dist: nose-exclude>=0.5.0; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Provides-Extra: experimental-aio
-Requires-Dist: aiounittest; python_version >= "3.8" and extra == "experimental-aio"
-Requires-Dist: motor>3.6.0; python_version >= "3.8" and extra == "experimental-aio"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
+Requires-Dist: cassandra-driver>=3.20; extra == 'test'
+Requires-Dist: coverage; extra == 'test'
+Requires-Dist: mock>=2.0.0; extra == 'test'
+Requires-Dist: mockredispy; extra == 'test'
+Requires-Dist: nose-exclude>=0.5.0; extra == 'test'
+Requires-Dist: nose>=1.3.7; extra == 'test'
+Requires-Dist: pymongo>=3.9.0; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-rerunfailures; extra == 'test'
+Requires-Dist: redis>=2.10.0; extra == 'test'
+Description-Content-Type: text/x-rst
 
 datasketch: Big Data Looks Small
 ================================
@@ -107,7 +97,7 @@ sub-linear query time:
 | `HNSW`_                   | Any                         | Custom Metric Top-K    |
 +---------------------------+-----------------------------+------------------------+
 
-datasketch must be used with Python 3.8 or above, NumPy 1.11 or above, and Scipy.
+datasketch must be used with Python 3.9 or above, NumPy 1.11 or above, and Scipy.
 
 Note that `MinHash LSH`_ and `MinHash LSH Ensemble`_ also support Redis and Cassandra 
 storage layer (see `MinHash LSH at Scale`_).
@@ -117,7 +107,7 @@ Install
 
 To install datasketch using ``pip``:
 
-::
+.. code-block:: bash
 
     pip install datasketch
 
@@ -125,19 +115,19 @@ This will also install NumPy as dependency.
 
 To install with Redis dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[redis]
 
 To install with Cassandra dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[cassandra]
 
 To install with Bloom filter dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[bloom]
 
@@ -151,3 +141,116 @@ To install with Bloom filter dependency:
 .. _`LSHBloom`: https://ekzhu.github.io/datasketch/lshbloom.html
 .. _`Minhash LSH at Scale`: http://ekzhu.github.io/datasketch/lsh.html#minhash-lsh-at-scale
 .. _`HNSW`: https://ekzhu.github.io/datasketch/documentation.html#hnsw
+
+Contributing
+------------
+
+We welcome contributions from everyone. Whether you're fixing bugs, adding features, improving documentation, or helping with tests, your contributions are valuable.
+
+Development Setup
+^^^^^^^^^^^^^^^^^
+
+The project uses `uv` for fast and reliable Python package management. Follow these steps to set up your development environment:
+
+1. **Install uv**: Follow the official installation guide at https://docs.astral.sh/uv/getting-started/installation/
+
+2. **Clone the repository**:
+
+   .. code-block:: bash
+
+       git clone https://github.com/ekzhu/datasketch.git
+       cd datasketch
+
+3. **Set up the environment**:
+
+   .. code-block:: bash
+
+       # Create a virtual environment
+       # (Optional: specify Python version with --python 3.x)
+       uv venv
+       # Activate the virtual environment (optional, uv run commands work without it)
+       source .venv/bin/activate
+
+       # Install all dependencies
+       uv sync
+
+4. **Verify installation**:
+
+   .. code-block:: bash
+
+       # Run tests to ensure everything works
+       uv run pytest
+
+5. **Optional dependencies** (for specific development needs):
+
+   .. code-block:: bash
+
+       # For testing
+       uv sync --extra test
+
+       # For Cassandra support
+       uv sync --extra cassandra
+
+       # For Redis support
+       uv sync --extra redis
+
+       # For all extras
+       uv sync --all-extras
+
+Learn more about `uv` at https://docs.astral.sh/uv/
+
+Development Workflow
+^^^^^^^^^^^^^^^^^^^^
+
+1. **Fork the repository** on GitHub if you haven't already.
+
+2. **Create a feature branch** for your changes:
+
+   .. code-block:: bash
+
+       git checkout -b feature/your-feature-name
+       # Or for bug fixes:
+       git checkout -b fix/issue-description
+
+3. **Make your changes** following the project's coding standards.
+
+4. **Run the tests** to ensure nothing is broken:
+
+   .. code-block:: bash
+
+       uv run pytest
+
+5. **Check code quality** with ruff:
+
+   .. code-block:: bash
+
+       # Check for issues
+       uvx ruff check .
+
+       # Auto-fix formatting issues
+       uvx ruff format .
+
+6. **Commit your changes** with a clear, descriptive commit message:
+
+   .. code-block:: bash
+
+       git commit -m "Add feature: brief description of what was changed"
+
+7. **Push to your fork** and create a pull request on GitHub:
+
+   .. code-block:: bash
+
+       git push origin your-branch-name
+
+8. **Respond to feedback** from maintainers and iterate on your changes.
+
+Guidelines
+^^^^^^^^^^
+
+- Follow PEP 8 style guidelines
+- Write tests for new features
+- Update documentation as needed
+- Keep commits focused and atomic
+- Be respectful in discussions
+
+For more information, check the `GitHub issues <https://github.com/ekzhu/datasketch/issues>`_ for current priorities or areas needing help. You can also join the discussion on `project roadmap and priorities <https://github.com/ekzhu/datasketch/discussions/252>`_.

datasketch-1.7.0/PKG-INFO → datasketch-1.8.0/README.rst

@@ -1,68 +1,3 @@
-Metadata-Version: 2.4
-Name: datasketch
-Version: 1.7.0
-Summary: Probabilistic data structures for processing and searching very large datasets
-Home-page: https://ekzhu.github.io/datasketch
-Author: ekzhu
-Author-email: ekzhu@cs.toronto.edu
-License: MIT
-Project-URL: Source, https://github.com/ekzhu/datasketch
-Keywords: database datamining
-Classifier: Development Status :: 5 - Production/Stable
-Classifier: Intended Audience :: Developers
-Classifier: Topic :: Database
-Classifier: Topic :: Scientific/Engineering :: Information Analysis
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3.11
-Classifier: Programming Language :: Python :: 3.12
-License-File: LICENSE
-Requires-Dist: numpy>=1.11
-Requires-Dist: scipy>=1.0.0
-Provides-Extra: cassandra
-Requires-Dist: cassandra-driver>=3.20; extra == "cassandra"
-Provides-Extra: redis
-Requires-Dist: redis>=2.10.0; extra == "redis"
-Provides-Extra: bloom
-Requires-Dist: pybloomfilter3>=0.7.2; python_version >= "3.9" and extra == "bloom"
-Requires-Dist: pybloomfiltermmap3==0.6.0; python_version < "3.9" and extra == "bloom"
-Provides-Extra: benchmark
-Requires-Dist: pyhash>=0.9.3; extra == "benchmark"
-Requires-Dist: matplotlib>=3.1.2; extra == "benchmark"
-Requires-Dist: scikit-learn>=0.21.3; extra == "benchmark"
-Requires-Dist: scipy>=1.3.3; extra == "benchmark"
-Requires-Dist: pandas>=0.25.3; extra == "benchmark"
-Requires-Dist: SetSimilaritySearch>=0.1.7; extra == "benchmark"
-Requires-Dist: pyfarmhash>=0.2.2; extra == "benchmark"
-Requires-Dist: nltk>=3.4.5; extra == "benchmark"
-Provides-Extra: test
-Requires-Dist: cassandra-driver>=3.20; extra == "test"
-Requires-Dist: redis>=2.10.0; extra == "test"
-Requires-Dist: mock>=2.0.0; extra == "test"
-Requires-Dist: mockredispy; extra == "test"
-Requires-Dist: coverage; extra == "test"
-Requires-Dist: pymongo>=3.9.0; extra == "test"
-Requires-Dist: nose>=1.3.7; extra == "test"
-Requires-Dist: nose-exclude>=0.5.0; extra == "test"
-Requires-Dist: pytest; extra == "test"
-Provides-Extra: experimental-aio
-Requires-Dist: aiounittest; python_version >= "3.8" and extra == "experimental-aio"
-Requires-Dist: motor>3.6.0; python_version >= "3.8" and extra == "experimental-aio"
-Dynamic: author
-Dynamic: author-email
-Dynamic: classifier
-Dynamic: description
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: license-file
-Dynamic: project-url
-Dynamic: provides-extra
-Dynamic: requires-dist
-Dynamic: summary
-
 datasketch: Big Data Looks Small
 ================================
 
@@ -107,7 +42,7 @@ sub-linear query time:
 | `HNSW`_                   | Any                         | Custom Metric Top-K    |
 +---------------------------+-----------------------------+------------------------+
 
-datasketch must be used with Python 3.8 or above, NumPy 1.11 or above, and Scipy.
+datasketch must be used with Python 3.9 or above, NumPy 1.11 or above, and Scipy.
 
 Note that `MinHash LSH`_ and `MinHash LSH Ensemble`_ also support Redis and Cassandra 
 storage layer (see `MinHash LSH at Scale`_).
@@ -117,7 +52,7 @@ Install
 
 To install datasketch using ``pip``:
 
-::
+.. code-block:: bash
 
     pip install datasketch
 
@@ -125,19 +60,19 @@ This will also install NumPy as dependency.
 
 To install with Redis dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[redis]
 
 To install with Cassandra dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[cassandra]
 
 To install with Bloom filter dependency:
 
-::
+.. code-block:: bash
 
     pip install datasketch[bloom]
 
@@ -151,3 +86,116 @@ To install with Bloom filter dependency:
 .. _`LSHBloom`: https://ekzhu.github.io/datasketch/lshbloom.html
 .. _`Minhash LSH at Scale`: http://ekzhu.github.io/datasketch/lsh.html#minhash-lsh-at-scale
 .. _`HNSW`: https://ekzhu.github.io/datasketch/documentation.html#hnsw
+
+Contributing
+------------
+
+We welcome contributions from everyone. Whether you're fixing bugs, adding features, improving documentation, or helping with tests, your contributions are valuable.
+
+Development Setup
+^^^^^^^^^^^^^^^^^
+
+The project uses `uv` for fast and reliable Python package management. Follow these steps to set up your development environment:
+
+1. **Install uv**: Follow the official installation guide at https://docs.astral.sh/uv/getting-started/installation/
+
+2. **Clone the repository**:
+
+   .. code-block:: bash
+
+       git clone https://github.com/ekzhu/datasketch.git
+       cd datasketch
+
+3. **Set up the environment**:
+
+   .. code-block:: bash
+
+       # Create a virtual environment
+       # (Optional: specify Python version with --python 3.x)
+       uv venv
+       # Activate the virtual environment (optional, uv run commands work without it)
+       source .venv/bin/activate
+
+       # Install all dependencies
+       uv sync
+
+4. **Verify installation**:
+
+   .. code-block:: bash
+
+       # Run tests to ensure everything works
+       uv run pytest
+
+5. **Optional dependencies** (for specific development needs):
+
+   .. code-block:: bash
+
+       # For testing
+       uv sync --extra test
+
+       # For Cassandra support
+       uv sync --extra cassandra
+
+       # For Redis support
+       uv sync --extra redis
+
+       # For all extras
+       uv sync --all-extras
+
+Learn more about `uv` at https://docs.astral.sh/uv/
+
+Development Workflow
+^^^^^^^^^^^^^^^^^^^^
+
+1. **Fork the repository** on GitHub if you haven't already.
+
+2. **Create a feature branch** for your changes:
+
+   .. code-block:: bash
+
+       git checkout -b feature/your-feature-name
+       # Or for bug fixes:
+       git checkout -b fix/issue-description
+
+3. **Make your changes** following the project's coding standards.
+
+4. **Run the tests** to ensure nothing is broken:
+
+   .. code-block:: bash
+
+       uv run pytest
+
+5. **Check code quality** with ruff:
+
+   .. code-block:: bash
+
+       # Check for issues
+       uvx ruff check .
+
+       # Auto-fix formatting issues
+       uvx ruff format .
+
+6. **Commit your changes** with a clear, descriptive commit message:
+
+   .. code-block:: bash
+
+       git commit -m "Add feature: brief description of what was changed"
+
+7. **Push to your fork** and create a pull request on GitHub:
+
+   .. code-block:: bash
+
+       git push origin your-branch-name
+
+8. **Respond to feedback** from maintainers and iterate on your changes.
+
+Guidelines
+^^^^^^^^^^
+
+- Follow PEP 8 style guidelines
+- Write tests for new features
+- Update documentation as needed
+- Keep commits focused and atomic
+- Be respectful in discussions
+
+For more information, check the `GitHub issues <https://github.com/ekzhu/datasketch/issues>`_ for current priorities or areas needing help. You can also join the discussion on `project roadmap and priorities <https://github.com/ekzhu/datasketch/discussions/252>`_.

{datasketch-1.7.0 → datasketch-1.8.0}/datasketch/__init__.py

@@ -1,18 +1,43 @@
-from datasketch.hyperloglog import HyperLogLog, HyperLogLogPlusPlus
-from datasketch.minhash import MinHash
+import importlib.metadata
+from typing import Final
+
+try:
+    _version = importlib.metadata.version(__name__)
+except importlib.metadata.PackageNotFoundError:
+    _version = "0.0.0"  # Fallback for development mode
+__version__: Final[str] = _version
+
 from datasketch.b_bit_minhash import bBitMinHash
+from datasketch.hashfunc import sha1_hash32
+from datasketch.hnsw import HNSW
+from datasketch.hyperloglog import HyperLogLog, HyperLogLogPlusPlus
+from datasketch.lean_minhash import LeanMinHash
 from datasketch.lsh import MinHashLSH
 from datasketch.lsh_bloom import MinHashLSHBloom
-from datasketch.weighted_minhash import WeightedMinHash, WeightedMinHashGenerator
-from datasketch.lshforest import MinHashLSHForest
 from datasketch.lshensemble import MinHashLSHEnsemble
-from datasketch.lean_minhash import LeanMinHash
-from datasketch.hashfunc import sha1_hash32
-from datasketch.hnsw import HNSW
+from datasketch.lshforest import MinHashLSHForest
+from datasketch.minhash import MinHash
+from datasketch.weighted_minhash import WeightedMinHash, WeightedMinHashGenerator
 
 # Alias
 WeightedMinHashLSH = MinHashLSH
 WeightedMinHashLSHForest = MinHashLSHForest
 
-# Version
-from datasketch.version import __version__
+
+__all__ = [
+    "HNSW",
+    "HyperLogLog",
+    "HyperLogLogPlusPlus",
+    "LeanMinHash",
+    "MinHash",
+    "MinHashLSH",
+    "MinHashLSHBloom",
+    "MinHashLSHEnsemble",
+    "MinHashLSHForest",
+    "WeightedMinHash",
+    "WeightedMinHashGenerator",
+    "WeightedMinHashLSH",
+    "WeightedMinHashLSHForest",
+    "bBitMinHash",
+    "sha1_hash32",
+]