gsppy 3.1.1__py3-none-any.whl → 3.2.7__py3-none-any.whl

gsppy/__init__.py

@@ -0,0 +1,24 @@
+"""Public interface for the :mod:`gsppy` package.
+
+This module centralizes the primary entry points, including the :class:`~gsppy.gsp.GSP`
+implementation, CLI helpers for loading transactional data, and the package version string.
+"""
+
+from importlib import metadata as importlib_metadata
+
+from gsppy.cli import detect_and_read_file, read_transactions_from_csv, read_transactions_from_json, setup_logging
+from gsppy.gsp import GSP
+
+try:
+    __version__ = importlib_metadata.version("gsppy")
+except importlib_metadata.PackageNotFoundError:  # pragma: no cover - handled only in editable installs
+    __version__ = "0.0.0"
+
+__all__ = [
+    "GSP",
+    "detect_and_read_file",
+    "read_transactions_from_csv",
+    "read_transactions_from_json",
+    "setup_logging",
+    "__version__",
+]

gsppy/accelerate.py

@@ -21,6 +21,7 @@ from .utils import split_into_batches, is_subsequence_in_list
 
 # Optional GPU (CuPy) support
 _gpu_available = False
+cp: Any | None = None
 try:  # pragma: no cover - optional dependency path
     import cupy as _cp_mod  # type: ignore[import-not-found]
 
@@ -126,8 +127,8 @@ def _support_counts_gpu_singletons(
     if not flat:
         return []
 
-    cp_flat = cp.asarray(flat, dtype=cp.int32)  # type: ignore[name-defined]
-    counts = cp.bincount(cp_flat, minlength=vocab_size)  # type: ignore[attr-defined]
+    cp_flat = cp.asarray(flat, dtype=cp.int32)  # type: ignore[name-defined, union-attr]
+    counts = cp.bincount(cp_flat, minlength=vocab_size)  # type: ignore[attr-defined, union-attr]
     counts_host: Any = counts.get()  # back to host as a NumPy array
 
     out: List[Tuple[List[int], int]] = []
@@ -178,6 +179,17 @@ def support_counts(
               fall back to CPU for the rest
     - "python": force pure-Python fallback
     - otherwise: try Rust first and fall back to Python
+
+    Example:
+        Running a search with an explicit backend:
+
+        ```python
+        from gsppy.accelerate import support_counts
+
+        transactions = [("A", "B"), ("A", "C")]
+        candidates = [("A",), ("B",), ("A", "B")]
+        counts = support_counts(transactions, candidates, min_support_abs=1, backend="python")
+        ```
     """
     backend_sel = (backend or _env_backend()).lower()
 
@@ -222,7 +234,8 @@ def support_counts(
                 try:
                     other_enc = [enc for enc, _ in others]
                     res = cast(
-                        List[Tuple[List[int], int]], _compute_supports_rust(enc_tx, other_enc, int(min_support_abs))
+                        List[Tuple[List[int], int]],
+                        _compute_supports_rust(enc_tx, other_enc, int(min_support_abs)),  # ty:ignore[call-non-callable]
                     )
                     for enc_cand, freq in res:
                         out[tuple(inv_vocab[i] for i in enc_cand)] = int(freq)
@@ -247,7 +260,10 @@ def support_counts(
         # use rust
         enc_tx, inv_vocab, vocab = _get_encoded_transactions(transactions)
         enc_cands = _encode_candidates(candidates, vocab)
-        result = cast(List[Tuple[List[int], int]], _compute_supports_rust(enc_tx, enc_cands, int(min_support_abs)))
+        result = cast(
+            List[Tuple[List[int], int]],
+            _compute_supports_rust(enc_tx, enc_cands, int(min_support_abs)),  # ty:ignore[call-non-callable]
+        )
         out_rust: Dict[Tuple[str, ...], int] = {}
         for enc_cand, freq in result:
             out_rust[tuple(inv_vocab[i] for i in enc_cand)] = int(freq)
@@ -258,7 +274,10 @@ def support_counts(
         enc_tx, inv_vocab, vocab = _get_encoded_transactions(transactions)
         enc_cands = _encode_candidates(candidates, vocab)
         try:
-            result = cast(List[Tuple[List[int], int]], _compute_supports_rust(enc_tx, enc_cands, int(min_support_abs)))
+            result = cast(
+                List[Tuple[List[int], int]],
+                _compute_supports_rust(enc_tx, enc_cands, int(min_support_abs)),  # ty:ignore[call-non-callable]
+            )
             out2: Dict[Tuple[str, ...], int] = {}
             for enc_cand, freq in result:
                 out2[tuple(inv_vocab[i] for i in enc_cand)] = int(freq)

gsppy/cli.py

@@ -45,7 +45,7 @@ logging.basicConfig(
     format="%(message)s",  # Simplified to keep CLI output clean
     handlers=[logging.StreamHandler(sys.stdout)],
 )
-logger = logging.getLogger(__name__)
+logger: logging.Logger = logging.getLogger(__name__)
 
 
 def setup_logging(verbose: bool) -> None:

gsppy/gsp.py

@@ -95,7 +95,7 @@ from collections import Counter
 from gsppy.utils import split_into_batches, is_subsequence_in_list, generate_candidates_from_previous
 from gsppy.accelerate import support_counts as support_counts_accel
 
-logger = logging.getLogger(__name__)
+logger: logging.Logger = logging.getLogger(__name__)
 
 
 class GSP:
@@ -171,7 +171,7 @@ class GSP:
             raise ValueError(msg)
 
         logger.info("Pre-processing transactions...")
-        self.max_size = max(len(item) for item in raw_transactions)
+        self.max_size: int = max(len(item) for item in raw_transactions)
         self.transactions: List[Tuple[str, ...]] = [tuple(transaction) for transaction in raw_transactions]
         counts: Counter[str] = Counter(chain.from_iterable(raw_transactions))
         # Start with singleton candidates (1-sequences)
@@ -295,6 +295,22 @@ class GSP:
             - Information about the algorithm's start, intermediate progress (candidates filtered),
               and completion.
             - Status updates for each iteration until the algorithm terminates.
+
+        Example:
+            Basic usage with the default backend:
+
+            ```python
+            from gsppy.gsp import GSP
+
+            transactions = [
+                ["Bread", "Milk"],
+                ["Bread", "Diaper", "Beer", "Eggs"],
+                ["Milk", "Diaper", "Beer", "Coke"],
+            ]
+
+            gsp = GSP(transactions)
+            patterns = gsp.search(min_support=0.3)
+            ```
         """
         if not 0.0 < min_support <= 1.0:
             raise ValueError("Minimum support must be in the range (0.0, 1.0]")

{gsppy-3.1.1.dist-info → gsppy-3.2.7.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: gsppy
-Version: 3.1.1
+Version: 3.2.7
 Summary: GSP (Generalized Sequence Pattern) algorithm in Python
 Project-URL: Homepage, https://github.com/jacksonpradolima/gsp-py
 Author-email: Jackson Antonio do Prado Lima <jacksonpradolima@gmail.com>
@@ -41,27 +41,34 @@ Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.10
 Requires-Dist: click>=8.0.0
 Provides-Extra: dev
-Requires-Dist: cython==3.1.4; extra == 'dev'
-Requires-Dist: hatch==1.15.1; extra == 'dev'
-Requires-Dist: hatchling==1.27.0; extra == 'dev'
-Requires-Dist: mypy==1.18.2; extra == 'dev'
-Requires-Dist: pylint==4.0.2; extra == 'dev'
-Requires-Dist: pyright==1.1.406; extra == 'dev'
-Requires-Dist: pytest-benchmark==5.1.0; extra == 'dev'
+Requires-Dist: cython==3.2.3; extra == 'dev'
+Requires-Dist: hatch==1.16.2; extra == 'dev'
+Requires-Dist: hatchling==1.28.0; extra == 'dev'
+Requires-Dist: pylint==4.0.4; extra == 'dev'
+Requires-Dist: pyright==1.1.407; extra == 'dev'
+Requires-Dist: pytest-benchmark==5.2.3; extra == 'dev'
 Requires-Dist: pytest-cov==7.0.0; extra == 'dev'
-Requires-Dist: pytest==8.4.2; extra == 'dev'
-Requires-Dist: ruff==0.13.3; extra == 'dev'
+Requires-Dist: pytest==9.0.2; extra == 'dev'
+Requires-Dist: ruff==0.14.10; extra == 'dev'
 Requires-Dist: tox==4.32.0; extra == 'dev'
+Requires-Dist: ty==0.0.8; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: mkdocs-gen-files<1,>=0.5; extra == 'docs'
+Requires-Dist: mkdocs-literate-nav<1,>=0.6; extra == 'docs'
+Requires-Dist: mkdocs-material<10,>=9.5; extra == 'docs'
+Requires-Dist: mkdocs<2,>=1.6; extra == 'docs'
+Requires-Dist: mkdocstrings[python]<0.27,>=0.26; extra == 'docs'
 Provides-Extra: gpu
 Requires-Dist: cupy<14,>=11; extra == 'gpu'
 Provides-Extra: rust
-Requires-Dist: maturin==1.9.6; extra == 'rust'
+Requires-Dist: maturin==1.10.2; extra == 'rust'
 Description-Content-Type: text/markdown
 
 [![PyPI License](https://img.shields.io/pypi/l/gsppy.svg?style=flat-square)]()
 ![](https://img.shields.io/badge/python-3.10+-blue.svg)
 [![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.3333987.svg)](https://doi.org/10.5281/zenodo.3333987)
 
+[![Docs](https://img.shields.io/badge/Docs-GSP--Py%20Site-3D9970?style=flat-square)](https://jacksonpradolima.github.io/gsp-py/)
 [![PyPI Downloads](https://img.shields.io/pypi/dm/gsppy.svg?style=flat-square)](https://pypi.org/project/gsppy/)
 [![Bugs](https://sonarcloud.io/api/project_badges/measure?project=jacksonpradolima_gsp-py&metric=bugs)](https://sonarcloud.io/summary/new_code?id=jacksonpradolima_gsp-py)
 [![Vulnerabilities](https://sonarcloud.io/api/project_badges/measure?project=jacksonpradolima_gsp-py&metric=vulnerabilities)](https://sonarcloud.io/summary/new_code?id=jacksonpradolima_gsp-py)
@@ -87,13 +94,15 @@ Sequence Pattern (GSP)** algorithm. Ideal for market basket analysis, temporal m
     - [❖ Clone Repository](#option-1-clone-the-repository)
     - [❖ Install via PyPI](#option-2-install-via-pip)
 4. [🛠️ Developer Installation](#developer-installation)
-5. [💡 Usage](#usage)
+5. [📖 Documentation](#documentation)
+6. [💡 Usage](#usage)
     - [✅ Example: Analyzing Sales Data](#example-analyzing-sales-data)
     - [📊 Explanation: Support and Results](#explanation-support-and-results)
-6. [🌟 Planned Features](#planned-features)
-7. [🤝 Contributing](#contributing)
-8. [📝 License](#license)
-9. [📖 Citation](#citation)
+7. [⌨️ Typing](#typing)
+8. [🌟 Planned Features](#planned-features)
+9. [🤝 Contributing](#contributing)
+10. [📝 License](#license)
+11. [📖 Citation](#citation)
 
 ---
 
@@ -245,7 +254,7 @@ make install             # sync deps (from uv.lock) + install project (-e .)
 make test                # pytest -n auto
 make lint                # ruff check .
 make format              # ruff --fix
-make typecheck           # pyright (and mypy if configured)
+make typecheck           # pyright + ty
 make pre-commit-install  # install the pre-commit hook
 make pre-commit-run      # run pre-commit on all files
 
@@ -259,6 +268,41 @@ make bench-big           # run large benchmark
 > [!NOTE]
 > Tox in this project uses the "tox-uv" plugin. When running `make tox` or `tox`, missing Python interpreters can be provisioned automatically via uv (no need to pre-install all versions). This makes local setup faster.
 
+## 🔏 Release assets and verification
+
+Every GitHub release bundles artifacts to help you validate what you download:
+
+- Built wheels and source distributions produced by the automated publish workflow.
+- `sbom.json` (CycloneDX) generated with [Syft](https://github.com/anchore/syft).
+- Sigstore-generated `.sig` and `.pem` files for each artifact, created using GitHub OIDC identity.
+
+To verify a downloaded artifact from a release:
+
+```bash
+python -m pip install sigstore  # installs the CLI
+sigstore verify identity \
+  --certificate gsppy-<version>-py3-none-any.whl.pem \
+  --signature gsppy-<version>-py3-none-any.whl.sig \
+  --cert-identity "https://github.com/jacksonpradolima/gsp-py/.github/workflows/publish.yml@refs/tags/v<version>" \
+  --cert-oidc-issuer https://token.actions.githubusercontent.com \
+  gsppy-<version>-py3-none-any.whl
+```
+
+Replace `<version>` with the numeric package version (for example, `3.1.1`) in the filenames; in `--cert-identity`, this becomes `v<version>` (for example, `v3.1.1`). Adjust the filenames for the sdist (`.tar.gz`) if preferred. The same release page also hosts `sbom.json` for supply-chain inspection.
+
+## 📖 Documentation
+
+- **Live site:** https://jacksonpradolima.github.io/gsp-py/
+- **Build locally:**
+
+  ```bash
+  uv venv .venv
+  uv sync --extra docs
+  uv run mkdocs serve
+  ```
+
+The docs use MkDocs with the Material theme and mkdocstrings to render the Python API directly from docstrings.
+
 ## 💡 Usage
 
 The library is designed to be easy to use and integrate with your own projects. You can use GSP-Py either programmatically (Python API) or directly from the command line (CLI).
@@ -485,6 +529,15 @@ result = gsp.search(min_support=0.5)  # Need at least 2/4 sequences
 
 ---
 
+## ⌨️ Typing
+
+`gsppy` ships inline type information (PEP 561) via a bundled `py.typed` marker. The public API is re-exported from
+`gsppy` directly—import `GSP` for programmatic use or reuse the CLI helpers (`detect_and_read_file`,
+`read_transactions_from_json`, `read_transactions_from_csv`, and `setup_logging`) when embedding the tool in
+larger applications.
+
+---
+
 ## 🌟 Planned Features
 
 We are actively working to improve GSP-Py. Here are some exciting features planned for future releases:

gsppy-3.2.7.dist-info/RECORD

@@ -0,0 +1,11 @@
+gsppy/__init__.py,sha256=FcWEYkzMCiqIBmc4yhgIXFKzvSNjJA7LX7juUabvoJ4,784
+gsppy/accelerate.py,sha256=2I3IA42FyPZvfwc0-f0bovZ8YgbdvJXj0qDlYWSWiXI,10998
+gsppy/cli.py,sha256=W5udAPKOjlxi-c-RKcz5HW-sDgoap4ojHD87bd-X498,6583
+gsppy/gsp.py,sha256=aCtPrldVNCkwj6wwytrZzbayYKkXi9Om-3xzrHUMkLQ,15293
+gsppy/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+gsppy/utils.py,sha256=KtjfDgsTwvwxIyA2KCQmgu8cFkBqQvMZN8Ct5NB60Tc,3952
+gsppy-3.2.7.dist-info/METADATA,sha256=H7qZ7b0DGtca_pA9uiY0fijQTvPmsFeHHGg9fzKc6V0,22130
+gsppy-3.2.7.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
+gsppy-3.2.7.dist-info/entry_points.txt,sha256=smvmcIWk424ARIGKOC_BM42hpT_SptKPcIeqs-8u8lM,41
+gsppy-3.2.7.dist-info/licenses/LICENSE,sha256=AlXanKSqFzo_o-87gp3Qw3XzbmnfxYy7O0xJOcQGWJo,1086
+gsppy-3.2.7.dist-info/RECORD,,

gsppy-3.1.1.dist-info/RECORD

@@ -1,10 +0,0 @@
-gsppy/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-gsppy/accelerate.py,sha256=YO3YQFzo2VAC6IXOTnQnOajkZO7SabkieGb1IPgWdSI,10407
-gsppy/cli.py,sha256=wsGoc_utxpRfgCF9vPOAyLDTOJZ8NaiwiUny5VyIYvQ,6567
-gsppy/gsp.py,sha256=GCHFhOu-DyHEPsse_OXzf9IaZoigF8ouRqgn_OsZBvA,14855
-gsppy/utils.py,sha256=KtjfDgsTwvwxIyA2KCQmgu8cFkBqQvMZN8Ct5NB60Tc,3952
-gsppy-3.1.1.dist-info/METADATA,sha256=uN-rN-CzsrwW_uh4s60DUevIKjm5CuiYyHRh5cgyKqQ,19819
-gsppy-3.1.1.dist-info/WHEEL,sha256=WLgqFyCfm_KASv4WHyYy0P3pM_m7J5L9k2skdKLirC8,87
-gsppy-3.1.1.dist-info/entry_points.txt,sha256=smvmcIWk424ARIGKOC_BM42hpT_SptKPcIeqs-8u8lM,41
-gsppy-3.1.1.dist-info/licenses/LICENSE,sha256=AlXanKSqFzo_o-87gp3Qw3XzbmnfxYy7O0xJOcQGWJo,1086
-gsppy-3.1.1.dist-info/RECORD,,