licenseid 0.1.0__tar.gz

licenseid-0.1.0/.github/copilot-instructions.md

@@ -0,0 +1 @@
+AGENTS.md

licenseid-0.1.0/.github/workflows/build.yml

@@ -0,0 +1,48 @@
+# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
+# SPDX-License-Identifier: Apache-2.0
+
+name: Build wheels
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  build-wheel:
+    name: Python ${{ matrix.python-version }} on ${{ matrix.os }}
+    runs-on: ${{ matrix.os }}
+    permissions:
+      contents: read
+    defaults:
+      run:
+        shell: bash
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
+        #include:
+        #  - os: windows-latest
+        #    python-version: "3.10"
+        #  - os: macos-latest
+        #    python-version: "3.10"
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install build dependencies
+        run: |
+          pip install --upgrade build pip
+          pip install .
+
+      - name: Build wheel
+        id: build
+        run: |
+          python -m build

licenseid-0.1.0/.github/workflows/lint.yml

@@ -0,0 +1,44 @@
+# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
+# SPDX-License-Identifier: Apache-2.0
+
+name: Lint and format
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  ruff:
+    name: Lint
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.10"
+
+      - name: Install Ruff
+        run: |
+          pip install --upgrade pip
+          pip install ".[dev,java]"
+
+      - name: Ruff linter
+        run: |
+          ruff check src/ tests/
+
+      - name: Pylint
+        run: |
+          pylint src/ tests/
+
+      - name: Flake8
+        run: |
+          flake8 src/ tests/
+
+      - name: Ruff formatter check
+        run: |
+          ruff format --check src/ tests/

licenseid-0.1.0/.github/workflows/pypi-publish.yml

@@ -0,0 +1,57 @@
+# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
+# SPDX-License-Identifier: Apache-2.0
+
+name: Publish to PyPI
+
+on:
+  release:
+    types: [ published ]
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.14"
+
+      - name: Install build dependencies
+        run: |
+          pip install --upgrade build pip
+          pip install -e .
+
+      - name: Build sdist and wheel
+        run: |
+          python -m build
+
+      - name: Upload distribution artifacts
+        uses: actions/upload-artifact@v7
+        with:
+          name: dist
+          path: dist/
+          retention-days: 3
+
+  publish:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write # required for trusted publishing (OIDC)
+
+    steps:
+      - name: Download distribution artifacts
+        uses: actions/download-artifact@v8
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

licenseid-0.1.0/.github/workflows/test.yml

@@ -0,0 +1,41 @@
+# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
+# SPDX-License-Identifier: Apache-2.0
+
+name: Unit tests
+
+on:
+  push:
+    branches: [ main, develop ]
+  pull_request:
+    branches: [ main, develop ]
+
+jobs:
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ "3.10", "3.11", "3.12", "3.13", "3.14" ]
+      fail-fast: true
+
+    steps:
+      - uses: actions/checkout@v6
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: |
+          pip install --upgrade pip
+          pip install ".[dev,java]"
+
+      - name: Run tests
+        run: |
+          pytest tests/ -v --tb=short
+
+      - name: Upload coverage reports
+        if: matrix.python-version == '3.14'
+        uses: codecov/codecov-action@v5
+        continue-on-error: true

licenseid-0.1.0/.gitignore

@@ -0,0 +1,138 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py.cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# celery beat schedule file
+celerybeat-schedule
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# IDEs
+.project
+.pydevproject
+.idea
+org.eclipse.core.resources.prefs
+.vscode
+
+.DS_Store
+.ruff_cache/
+.pytest_cache/
+
+# Local testing files
+dummy.db
+tests/tool.jar

licenseid-0.1.0/LICENSE

@@ -0,0 +1,15 @@
+Apache Software License 2.0
+
+Copyright (c) 2026, Arthit Suriyawongkul
+
+Licensed under the Apache License, Version 2.0 (the "License");
+you may not use this file except in compliance with the License.
+You may obtain a copy of the License at
+
+http://www.apache.org/licenses/LICENSE-2.0
+
+Unless required by applicable law or agreed to in writing, software
+distributed under the License is distributed on an "AS IS" BASIS,
+WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+See the License for the specific language governing permissions and
+limitations under the License.

licenseid-0.1.0/PKG-INFO

@@ -0,0 +1,114 @@
+Metadata-Version: 2.4
+Name: licenseid
+Version: 0.1.0
+Summary: Get the SPDX License ID from license text
+Author-email: Arthit Suriyawongkul <suriyawa@tcd.ie>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: license,license-matcher,licenseid,matcher,opensource,spdx
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.10
+Requires-Dist: beautifulsoup4>=4.10.0
+Requires-Dist: click>=8.0.0
+Requires-Dist: rapidfuzz>=3.0.0
+Requires-Dist: requests>=2.28.0
+Provides-Extra: dev
+Requires-Dist: flake8; extra == 'dev'
+Requires-Dist: mypy; extra == 'dev'
+Requires-Dist: pylint; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
+Requires-Dist: pytest-cov; extra == 'dev'
+Requires-Dist: ruff; extra == 'dev'
+Provides-Extra: java
+Requires-Dist: jpype1>=1.7.0; extra == 'java'
+Description-Content-Type: text/markdown
+
+# LicenseID
+
+A portable SPDX License ID matcher.
+
+`licenseid` takes license text as input and identifies the closest matched SPDX License ID using a hybrid search strategy (SQLite FTS5 trigram + RapidFuzz ranking + optional Java validation).
+
+## Features
+
+- **Hybrid strategy**:
+  - **Tier 1**: Broad recall using SQLite FTS5 with trigram tokenization.
+  - **Tier 2**: Precision ranking using RapidFuzz (token set ratio) + Popularity weighting.
+  - **Tier 3**: Optional final validation via `tools-java` if available.
+- **Unix philosophy**: Parseable CLI output.
+
+## Installation
+
+Install with `pipx`:
+
+```bash
+pipx install licenseid
+```
+
+Or using `uv`:
+
+```bash
+uv tool install licenseid
+```
+
+## Usage
+
+### 1. Update the license database
+
+Before matching, you need to build the local license index:
+
+```bash
+licenseid update
+```
+
+### 2. Match a license
+
+Match text from a file:
+
+```bash
+licenseid match LICENSE.txt
+```
+
+Match with Java validation enabled:
+
+```bash
+licenseid match LICENSE.txt --java
+```
+
+Match with popularity tie-breaker enabled:
+
+```bash
+licenseid match LICENSE.txt --pop
+```
+
+The tie-breaker is triggered only when candidate similarity scores
+differ by less than 0.02%.
+
+### 3. Output formats
+
+Default (Unix-friendly):
+
+```text
+LICENSE_ID=Apache-2.0 SCORE=0.9850
+```
+
+JSON:
+
+```bash
+licenseid match LICENSE.txt --json
+```
+
+## Configuration
+
+- `SPDX_TOOLS_JAR`: Path to the `tools-java` jar for Tier 3 validation.
+
+## License
+
+Apache-2.0

licenseid-0.1.0/README.md

@@ -0,0 +1,82 @@
+# LicenseID
+
+A portable SPDX License ID matcher.
+
+`licenseid` takes license text as input and identifies the closest matched SPDX License ID using a hybrid search strategy (SQLite FTS5 trigram + RapidFuzz ranking + optional Java validation).
+
+## Features
+
+- **Hybrid strategy**:
+  - **Tier 1**: Broad recall using SQLite FTS5 with trigram tokenization.
+  - **Tier 2**: Precision ranking using RapidFuzz (token set ratio) + Popularity weighting.
+  - **Tier 3**: Optional final validation via `tools-java` if available.
+- **Unix philosophy**: Parseable CLI output.
+
+## Installation
+
+Install with `pipx`:
+
+```bash
+pipx install licenseid
+```
+
+Or using `uv`:
+
+```bash
+uv tool install licenseid
+```
+
+## Usage
+
+### 1. Update the license database
+
+Before matching, you need to build the local license index:
+
+```bash
+licenseid update
+```
+
+### 2. Match a license
+
+Match text from a file:
+
+```bash
+licenseid match LICENSE.txt
+```
+
+Match with Java validation enabled:
+
+```bash
+licenseid match LICENSE.txt --java
+```
+
+Match with popularity tie-breaker enabled:
+
+```bash
+licenseid match LICENSE.txt --pop
+```
+
+The tie-breaker is triggered only when candidate similarity scores
+differ by less than 0.02%.
+
+### 3. Output formats
+
+Default (Unix-friendly):
+
+```text
+LICENSE_ID=Apache-2.0 SCORE=0.9850
+```
+
+JSON:
+
+```bash
+licenseid match LICENSE.txt --json
+```
+
+## Configuration
+
+- `SPDX_TOOLS_JAR`: Path to the `tools-java` jar for Tier 3 validation.
+
+## License
+
+Apache-2.0

licenseid-0.1.0/pyproject.toml

@@ -0,0 +1,62 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "licenseid"
+version = "0.1.0"
+description = "Get the SPDX License ID from license text"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Apache-2.0"
+authors = [{ name = "Arthit Suriyawongkul", email = "suriyawa@tcd.ie" }]
+keywords = [
+    "license",
+    "matcher",
+    "spdx",
+    "license-matcher",
+    "opensource",
+    "licenseid",
+]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+]
+dependencies = [
+    "beautifulsoup4>=4.10.0",
+    "click>=8.0.0",
+    "rapidfuzz>=3.0.0",
+    "requests>=2.28.0",
+]
+
+[project.optional-dependencies]
+dev = ["flake8", "mypy", "pylint", "pytest", "pytest-cov", "ruff"]
+java = ["jpype1>=1.7.0"]
+
+[project.scripts]
+licenseid = "licenseid.cli:main"
+
+[tool.hatch.build.targets.sdist]
+exclude = ["AGENTS.md", "GEMINI.md", "tests/fixtures/**", "scripts/**"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/licenseid"]
+
+[tool.ruff]
+line-length = 88
+target-version = "py310"
+
+[tool.mypy]
+strict = true
+python_version = "3.10"
+
+[tool.pytest.ini_options]
+markers = [
+    "benchmark: marks tests as slow benchmark (deselect with '-m \"not benchmark\"')",
+]

licenseid-0.1.0/src/licenseid/__init__.py

@@ -0,0 +1,14 @@
+# SPDX-FileCopyrightText: 2026-present Arthit Suriyawongkul
+# SPDX-FileType: SOURCE
+# SPDX-License-Identifier: Apache-2.0
+
+__version__ = "0.1.0"
+
+from licenseid.matcher import AggregatedLicenseMatcher
+from licenseid.database import LicenseDatabase, normalize_text
+
+__all__ = [
+    "AggregatedLicenseMatcher",
+    "LicenseDatabase",
+    "normalize_text",
+]