pyprocessors-glotlid 1.6.3__tar.gz

pyprocessors_glotlid-1.6.3/.gitignore

@@ -0,0 +1,137 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# 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/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+results.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# 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/
+
+# Specific
+.idea/
+.groovylintrc.json
+.emailNotif
+uv.lock
+
+# SBOMs
+**/sbom*.json
+**/trivy*.html
+**/audit*.json

pyprocessors_glotlid-1.6.3/AUTHORS.md

@@ -0,0 +1,5 @@
+# Authors
+
+Contributors to pyprocessors_glotlid include:
+
++ [Olivier Terrier](mailto:olivier.terrier@kairntech.com)

pyprocessors_glotlid-1.6.3/CHANGELOG.md

@@ -0,0 +1,7 @@
+# Changelog
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [unreleased]

pyprocessors_glotlid-1.6.3/LICENSE

@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2021 Olivier Terrier
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in
+all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+THE SOFTWARE.

pyprocessors_glotlid-1.6.3/PKG-INFO

@@ -0,0 +1,146 @@
+Metadata-Version: 2.4
+Name: pyprocessors-glotlid
+Version: 1.6.3
+Summary: Sherpa Consolidation processor
+Project-URL: Homepage, https://github.com/oterrier/pyprocessors_glotlid/
+Author-email: Olivier Terrier <olivier.terrier@kairntech.com>
+License: The MIT License (MIT)
+        
+        Copyright (c) 2021 Olivier Terrier
+        
+        Permission is hereby granted, free of charge, to any person obtaining a copy
+        of this software and associated documentation files (the "Software"), to deal
+        in the Software without restriction, including without limitation the rights
+        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+        copies of the Software, and to permit persons to whom the Software is
+        furnished to do so, subject to the following conditions:
+        
+        The above copyright notice and this permission notice shall be included in
+        all copies or substantial portions of the Software.
+        
+        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
+        THE SOFTWARE.
+License-File: AUTHORS.md
+License-File: LICENSE
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: System Administrators
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Software Development :: Libraries :: Application Frameworks
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.12
+Requires-Dist: fasttext-numpy2-wheel
+Requires-Dist: huggingface-hub
+Requires-Dist: iso639-lang
+Requires-Dist: log-with-context
+Requires-Dist: pymultirole-plugins<1.7.0,>=1.6.0
+Provides-Extra: dev
+Requires-Dist: bump2version; extra == 'dev'
+Requires-Dist: pre-commit; extra == 'dev'
+Provides-Extra: docs
+Requires-Dist: lxml-html-clean; extra == 'docs'
+Requires-Dist: m2r2; extra == 'docs'
+Requires-Dist: sphinx; extra == 'docs'
+Requires-Dist: sphinx-rtd-theme; extra == 'docs'
+Requires-Dist: sphinxcontrib-apidoc; extra == 'docs'
+Provides-Extra: sbom
+Requires-Dist: cyclonedx-bom; extra == 'sbom'
+Requires-Dist: pip-audit; extra == 'sbom'
+Provides-Extra: test
+Requires-Dist: dirty-equals; extra == 'test'
+Requires-Dist: pip; extra == 'test'
+Requires-Dist: pytest; extra == 'test'
+Requires-Dist: pytest-cov; extra == 'test'
+Requires-Dist: ruff; extra == 'test'
+Description-Content-Type: text/markdown
+
+# pyprocessors_glotlid
+
+[![license](https://img.shields.io/github/license/oterrier/pyprocessors_glotlid)](https://github.com/oterrier/pyprocessors_glotlid/blob/master/LICENSE)
+[![tests](https://github.com/oterrier/pyprocessors_glotlid/workflows/tests/badge.svg)](https://github.com/oterrier/pyprocessors_glotlid/actions?query=workflow%3Atests)
+[![codecov](https://img.shields.io/codecov/c/github/oterrier/pyprocessors_glotlid)](https://codecov.io/gh/oterrier/pyprocessors_glotlid)
+[![docs](https://img.shields.io/readthedocs/pyprocessors_glotlid)](https://pyprocessors_glotlid.readthedocs.io)
+[![version](https://img.shields.io/pypi/v/pyprocessors_glotlid)](https://pypi.org/project/pyprocessors_glotlid/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyprocessors_glotlid)](https://pypi.org/project/pyprocessors_glotlid/)
+
+GlotLID annotations coming from different annotators
+
+## Installation
+
+You can simply `pip install pyprocessors_glotlid`.
+
+## Developing
+
+### Pre-requisites
+
+You will need to install `uv` (for managing dependencies and running tests):
+
+```
+pip install uv
+```
+
+Clone the repository:
+
+```
+git clone https://github.com/oterrier/pyprocessors_glotlid
+```
+
+### Running the test suite
+
+Install dependencies and run the full test suite:
+
+```
+uv sync --extra test
+uv run pytest
+```
+
+### Linting
+
+```
+uv run ruff check .
+uv run ruff format --check .
+```
+
+### Building the documentation
+
+```
+uv run --extra docs sphinx-build docs docs/_build
+```
+
+The built documentation is available at `docs/_build/index.html`.
+
+## SBOM & vulnerability check
+
+Install the SBOM dependencies:
+
+```
+uv sync --extra sbom
+```
+
+Generate a CycloneDX SBOM from the current environment:
+
+```
+uv run cyclonedx-py environment -o sbom.cdx.json --output-format json
+```
+
+Audit dependencies for known vulnerabilities:
+
+```
+uv run pip-audit --format json --output audit-report.json
+```
+
+To fail on any known vulnerability (useful in CI):
+
+```
+uv run pip-audit --strict
+```

pyprocessors_glotlid-1.6.3/README.md

@@ -0,0 +1,80 @@
+# pyprocessors_glotlid
+
+[![license](https://img.shields.io/github/license/oterrier/pyprocessors_glotlid)](https://github.com/oterrier/pyprocessors_glotlid/blob/master/LICENSE)
+[![tests](https://github.com/oterrier/pyprocessors_glotlid/workflows/tests/badge.svg)](https://github.com/oterrier/pyprocessors_glotlid/actions?query=workflow%3Atests)
+[![codecov](https://img.shields.io/codecov/c/github/oterrier/pyprocessors_glotlid)](https://codecov.io/gh/oterrier/pyprocessors_glotlid)
+[![docs](https://img.shields.io/readthedocs/pyprocessors_glotlid)](https://pyprocessors_glotlid.readthedocs.io)
+[![version](https://img.shields.io/pypi/v/pyprocessors_glotlid)](https://pypi.org/project/pyprocessors_glotlid/)
+[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/pyprocessors_glotlid)](https://pypi.org/project/pyprocessors_glotlid/)
+
+GlotLID annotations coming from different annotators
+
+## Installation
+
+You can simply `pip install pyprocessors_glotlid`.
+
+## Developing
+
+### Pre-requisites
+
+You will need to install `uv` (for managing dependencies and running tests):
+
+```
+pip install uv
+```
+
+Clone the repository:
+
+```
+git clone https://github.com/oterrier/pyprocessors_glotlid
+```
+
+### Running the test suite
+
+Install dependencies and run the full test suite:
+
+```
+uv sync --extra test
+uv run pytest
+```
+
+### Linting
+
+```
+uv run ruff check .
+uv run ruff format --check .
+```
+
+### Building the documentation
+
+```
+uv run --extra docs sphinx-build docs docs/_build
+```
+
+The built documentation is available at `docs/_build/index.html`.
+
+## SBOM & vulnerability check
+
+Install the SBOM dependencies:
+
+```
+uv sync --extra sbom
+```
+
+Generate a CycloneDX SBOM from the current environment:
+
+```
+uv run cyclonedx-py environment -o sbom.cdx.json --output-format json
+```
+
+Audit dependencies for known vulnerabilities:
+
+```
+uv run pip-audit --format json --output audit-report.json
+```
+
+To fail on any known vulnerability (useful in CI):
+
+```
+uv run pip-audit --strict
+```

pyprocessors_glotlid-1.6.3/RELEASE.md

@@ -0,0 +1,39 @@
+# Release Instructions
+
+This document guides a contributor through creating a release of pyprocessors_glotlid.
+
+## Preflight checks
+
+### Ensure all tests pass
+
+Locally you can run `tox` to check that all tests pass, and check that tests
+against all supported environments are passing also by checking qsim's
+[GitHub actions](https://github.com/oterrier/pyprocessors_glotlid/actions?query=branch%3Amaster+workflow%3Atests).
+
+#### Verify that `AUTHORS.md` is up-to-date
+
+The following command shows the number of commits per author since the last
+annotated tag:
+```
+t=$(git describe --abbrev=0); echo Commits since $t; git shortlog -s $t..
+```
+
+## Make the release
+
+Run
+
+```
+bumpversion release  # bump version from .devX to release version
+git push --tags      # push tagged release to upstream
+flit publish         # publish to PyPI
+```
+
+## Start work on the next release
+
+Run
+
+```
+bumpversion minor
+```
+
+To start work on the next release

pyprocessors_glotlid-1.6.3/pyproject.toml

@@ -0,0 +1,100 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "pyprocessors-glotlid"
+dynamic = ["version"]
+description = "Sherpa Consolidation processor"
+readme = "README.md"
+license = {file = "LICENSE"}
+authors = [
+    {name = "Olivier Terrier", email = "olivier.terrier@kairntech.com"},
+]
+keywords = []
+classifiers = [
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Developers",
+    "Intended Audience :: System Administrators",
+    "Operating System :: OS Independent",
+    "Topic :: Software Development :: Libraries :: Application Frameworks",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Software Development",
+    "License :: OSI Approved :: MIT License",
+    "Development Status :: 4 - Beta",
+    "Programming Language :: Python :: 3.12",
+]
+requires-python = ">=3.12"
+dependencies = [
+    "pymultirole-plugins>=1.6.0,<1.7.0",
+    "fasttext-numpy2-wheel",
+    "huggingface_hub",
+    "log-with-context",
+    "iso639-lang",
+]
+
+[project.urls]
+Homepage = "https://github.com/oterrier/pyprocessors_glotlid/"
+
+[project.entry-points."pyprocessors.plugins"]
+glotlid = "pyprocessors_glotlid.glotlid:GlotLIDProcessor"
+
+[project.optional-dependencies]
+test = [
+    "pytest",
+    "pytest-cov",
+    "ruff",
+    "pip",
+    "dirty-equals",
+]
+docs = [
+    "sphinx",
+    "sphinx-rtd-theme",
+    "m2r2",
+    "sphinxcontrib.apidoc",
+    "lxml_html_clean",
+]
+dev = [
+    "pre-commit",
+    "bump2version",
+]
+
+sbom = ["cyclonedx-bom", "pip-audit"]
+
+[tool.hatch.version]
+path = "src/pyprocessors_glotlid/__init__.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/pyprocessors_glotlid"]
+
+[tool.hatch.build]
+exclude = [
+  "/tests",
+  "/docs",
+  "Jenkinsfile",
+  "Dockerfile",
+  "bumpversion.py",
+  "mypy.ini",
+  "hgnc_cache.sqlite",
+  "trivy-html-template.tpl",
+  "MIGRATION.md",
+  ".gitignore",
+  ".dockerignore"
+]
+
+[tool.pytest.ini_options]
+addopts = "--durations=5"
+norecursedirs = ["docs"]
+
+[tool.ruff]
+line-length = 120
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "W", "F", "I", "B", "C4", "UP", "ARG", "SIM"]
+ignore = ["E501"]
+
+[tool.ruff.format]
+quote-style = "double"
+indent-style = "space"

pyprocessors_glotlid-1.6.3/src/pyprocessors_glotlid/__init__.py

@@ -0,0 +1,3 @@
+"""Sherpa Consolidation processor"""
+
+__version__ = "1.6.3"

pyprocessors_glotlid-1.6.3/src/pyprocessors_glotlid/glotlid.py

@@ -0,0 +1,61 @@
+from functools import cache
+from typing import cast
+
+import fasttext
+from huggingface_hub import hf_hub_download
+from iso639 import Lang
+from iso639.exceptions import InvalidLanguageValue
+from log_with_context import Logger, add_logging_context
+from pydantic import BaseModel
+from pymultirole_plugins.v1.processor import ProcessorBase, ProcessorParameters
+from pymultirole_plugins.v1.schema import Document
+
+logger = Logger("pymultirole")
+
+
+class GlotLIDParameters(ProcessorParameters):
+    pass
+
+
+class GlotLIDProcessor(ProcessorBase):
+    """GlotLID processor ."""
+
+    def process(self, documents: list[Document], parameters: ProcessorParameters) -> list[Document]:  # noqa: C901
+        params: GlotLIDParameters = cast(GlotLIDParameters, parameters)  # noqa: F841
+        model = get_model()
+        for document in documents:
+            with add_logging_context(docid=document.identifier):
+                if document.metadata is None:
+                    document.metadata = {}
+                text = (document.text or "").replace("\n", " ").replace("\r", " ").strip()
+                if not text:
+                    continue
+                labels, _ = model.predict(text)
+                document.metadata["language"] = _to_iso639_1(labels[0])
+        return documents
+
+    @classmethod
+    def get_model(cls) -> type[BaseModel]:
+        return GlotLIDParameters
+
+
+def _to_iso639_1(label: str) -> str:
+    # GlotLID labels look like "__label__fra_Latn"; keep only the language part.
+    code = label.removeprefix("__label__").split("_", 1)[0]
+    try:
+        pt1 = Lang(code).pt1
+    except InvalidLanguageValue:
+        return code
+    return pt1 or code
+
+
+@cache
+def get_model(ttl_hash=None):
+    del ttl_hash
+    # download model and get the model path
+    # cache_dir is the path to the folder where the downloaded model will be stored/cached.
+    model_path = hf_hub_download(repo_id="cis-lmu/glotlid", filename="model.bin", cache_dir=None)
+
+    # load the model
+    model = fasttext.load_model(model_path)
+    return model