wordlevel 0.0.1a2__tar.gz

wordlevel-0.0.1a2/.github/actions/detect-changed-lexicons/action.yaml

@@ -0,0 +1,21 @@
+name: 'Detect Changed Lexicons'
+description: 'Determines which lexicons changed and how'
+
+outputs:
+  lexicon_changes:
+    description: "A JSON array of lexicons and booleans indicating how they have changed"
+    value: ${{ steps.detect-lexicons.outputs.lexicon_changes }}
+
+runs:
+  using: "composite"
+  steps:
+    - name: Get Changed Files
+      id: changed-files
+      uses: tj-actions/changed-files@v47.0.5
+      with:
+        files: lexicons/**
+
+    - name: Detected Changed Lexicon Files
+      id: detect-lexicons
+      shell: bash
+      run: python .github/scripts/process_lexicons.py "${{ steps.changed-files.outputs.all_changed_files }}"

wordlevel-0.0.1a2/.github/actions/process-lexicons/action.yaml

@@ -0,0 +1,18 @@
+name: 'Process Lexicon Data'
+description: 'Downloads raw lexicon data from Hugging Face and processes it'
+
+inputs:
+  lexicon:
+    description: 'The name of the lexicon'
+    required: true
+
+runs:
+  using: "composite"
+  steps:
+    - name: Download Raw Lexicon Data
+      shell: bash
+      run: uv run python -m lexicons.huggingface --mode download --data raw --lexicon ${{ inputs.lexicon }}
+        
+    - name: Process Lexicon
+      shell: bash
+      run: uv run python -m lexicons.${{ inputs.lexicon }}.process

wordlevel-0.0.1a2/.github/scripts/process_lexicons.py

@@ -0,0 +1,74 @@
+import os
+import argparse
+import json
+from pathlib import Path
+
+
+def main():
+    """ """
+    parser = argparse.ArgumentParser(
+        description="Parse changed files to determine which lexicons need processing"
+    )
+    parser.add_argument(
+        "changed_files",
+        type=str,
+        help="A space-separated string of file paths changed in the commit",
+    )
+
+    get_changed_lexicons(parser.parse_args())
+
+
+def get_changed_lexicons(args: argparse.Namespace) -> None:
+    """ """
+    if not args.changed_files.strip():
+        set_github_output("matrix_array", "[]")
+        return
+
+    lexicon_states = {}
+    changed_fs = args.changed_files.split()
+    for f_path in changed_fs:
+        # lexicons/{lexicon}/{changed_f}
+        path_parts = Path(f_path).parts
+
+        # The length check ensures it's a file in `lexicons/*/{lexicon}` and not just `lexicons/*`
+        if not (path_parts[0] == "lexicons" and len(path_parts) >= 3):
+            continue
+
+        lexicon = path_parts[1]
+        file_name = path_parts[2]
+
+        if lexicon not in lexicon_states:
+            lexicon_states[lexicon] = {
+                "name": lexicon,
+                "processor_changed": False,
+                "readme_changed": False,
+                "license_changed": False,
+            }
+
+        if file_name == "README.md":
+            lexicon_states[lexicon]["readme_changed"] = True
+        elif file_name == "LICENSE":
+            lexicon_states[lexicon]["license_changed"] = True
+        elif file_name == "process.py":
+            lexicon_states[lexicon]["processor_changed"] = True
+
+    # Output directly to the GitHub Actions $GITHUB_OUTPUT environment
+    set_github_output("lexicon_changes", json.dumps(list(lexicon_states.values())))
+
+
+def set_github_output(key: str, value: str) -> None:
+    """
+    Writes a key-value pair to the GitHub Actions output file. If no such file exists in the
+    environment, just prints to the local standard out
+    """
+    github_output_path = os.environ.get("GITHUB_OUTPUT")
+
+    if github_output_path:
+        with open(github_output_path, "a") as outfile:
+            outfile.write(f"{key}={value}\n")
+    else:
+        print(f"{key}={value}")
+
+
+if __name__ == "__main__":
+    main()

wordlevel-0.0.1a2/.github/workflows/lexicons-deployment.yaml

@@ -0,0 +1,79 @@
+name: Deploy lexicons
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      # Only trigger this workflow if files inside the lexicons/ folder change
+      - 'lexicons/**'
+
+jobs:
+  # ==========================================
+  # JOB 1: Detect and Categorize Changes
+  # ==========================================
+  changed-lexicons:
+    runs-on: ubuntu-latest
+    outputs:
+      lexicon_changes: ${{ steps.detect.outputs.lexicon_changes }}
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Detect Changes
+        id: detect
+        uses: ./.github/actions/detect-changed-lexicons
+
+
+  # ==========================================
+  # JOB 2: Process and Upload Lexicons
+  # ==========================================
+  deploy-lexicons:
+    needs: changed-lexicons
+    if: ${{ needs.changed-lexicons.outputs.lexicon_changes != '[]' && needs.changed-lexicons.outputs.lexicon_changes != '' }}
+    runs-on: ubuntu-latest
+    environment: huggingface
+    strategy:
+      matrix:
+        lexicon: ${{ fromJSON(needs.changed-lexicons.outputs.lexicon_changes) }}
+        
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          
+      - name: Install Python dependencies
+        run: uv sync --all-extras --dev
+
+      # --- Download and process lexicon ---
+      - name: Download and process lexicon
+        if: ${{ matrix.lexicon.processor_changed == true }}
+        uses: ./.github/actions/process-lexicons
+        with:
+          lexicon: ${{ matrix.lexicon.name }}
+
+      # --- Upload lexicon ---
+      - name: Upload lexicon
+        if: ${{ matrix.lexicon.processor_changed == true }}
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: uv run python -m lexicons.huggingface --mode upload --data processed --lexicon ${{ matrix.lexicon.name }}
+
+      # --- Upload metadata ---
+      - name: Upload README.md
+        if: ${{ matrix.lexicon.readme_changed == true }}
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: uv run python -m lexicons.huggingface --mode upload --lexicon ${{ matrix.lexicon.name }} --metadata README.md
+
+      - name: Upload LICENSE
+        if: ${{ matrix.lexicon.license_changed == true }}
+        env:
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}
+        run: uv run python -m lexicons.huggingface --mode upload --lexicon ${{ matrix.lexicon.name }} --metadata LICENSE

wordlevel-0.0.1a2/.github/workflows/lexicons-pull-request.yaml

@@ -0,0 +1,56 @@
+name: Process lexicons
+
+on:
+  pull_request:
+    branches:
+      - main
+    paths:
+      # Only trigger this workflow if files inside the lexicons/ folder change
+      - 'lexicons/**'
+
+jobs:
+  # ==========================================
+  # JOB 1: Detect and Categorize Changes
+  # ==========================================
+  changed-lexicons:
+    runs-on: ubuntu-latest
+    outputs:
+      lexicon_changes: ${{ steps.detect.outputs.lexicon_changes }}
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Detect Changes
+        id: detect
+        uses: ./.github/actions/detect-changed-lexicons
+
+  # ==========================================
+  # JOB 2: Process Lexicons (No Uploading)
+  # ==========================================
+  process-lexicons:
+    needs: changed-lexicons
+    if: ${{ needs.changed-lexicons.outputs.lexicon_changes != '[]' && needs.changed-lexicons.outputs.lexicon_changes != '' }}
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        lexicon: ${{ fromJSON(needs.changed-lexicons.outputs.lexicon_changes) }}
+    
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+      
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+          
+      - name: Install Python dependencies
+        run: uv sync --all-extras --dev
+
+      - name: Download and process lexicons
+        if: ${{ matrix.lexicon.processor_changed == true }}
+        uses: ./.github/actions/process-lexicons
+        with:
+          lexicon: ${{ matrix.lexicon.name }}

wordlevel-0.0.1a2/.github/workflows/pyright.yaml

@@ -0,0 +1,39 @@
+name: Pyright
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  type-check:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.14"
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+
+      - name: Enable uv caching
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install Python
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run Pyright
+        run: uv run pyright

wordlevel-0.0.1a2/.github/workflows/release.yaml

@@ -0,0 +1,90 @@
+name: Release
+
+on:
+  push:
+    tags:
+      - "v*"
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    uses: ./.github/workflows/test.yaml
+
+  type-check:
+    uses: ./.github/workflows/pyright.yaml
+
+  lint:
+    uses: ./.github/workflows/ruff.yaml
+
+  build:
+    needs: [test, type-check, lint]
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Install Python and enable uv caching
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: "3.14"
+          enable-cache: true
+
+      - name: Build sdist and wheel
+        run: uv build
+
+      - name: Upload build artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  pypi:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/wordlevel
+    permissions:
+      id-token: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  github-release:
+    needs: [pypi]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Download build artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+      - name: Determine if pre-release
+        id: prerelease
+        run: |
+          if [[ "${GITHUB_REF_NAME}" =~ (a[0-9]+|b[0-9]+|rc[0-9]+|dev[0-9]+)$ ]]; then
+            echo "flag=true" >> "$GITHUB_OUTPUT"
+          else
+            echo "flag=false" >> "$GITHUB_OUTPUT"
+          fi
+
+      - name: Create GitHub release
+        uses: softprops/action-gh-release@v2
+        with:
+          files: dist/*
+          generate_release_notes: true
+          prerelease: ${{ steps.prerelease.outputs.flag }}
+          draft: ${{ steps.prerelease.outputs.flag == 'false' }}

wordlevel-0.0.1a2/.github/workflows/ruff.yaml

@@ -0,0 +1,25 @@
+name: Ruff
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+
+      - name: Run Ruff check
+        uses: astral-sh/ruff-action@v3
+
+      - name: Run Ruff format
+        uses: astral-sh/ruff-action@v3
+        with:
+          args: "format --check --diff"

wordlevel-0.0.1a2/.github/workflows/test.yaml

@@ -0,0 +1,39 @@
+name: Pytest
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+  workflow_call:
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version:
+          - "3.10"
+          - "3.14"
+    steps:
+      - name: Checkout branch
+        uses: actions/checkout@v4
+
+      - name: Enable uv caching
+        uses: astral-sh/setup-uv@v6
+        with:
+          enable-cache: true
+
+      - name: Install Python
+        uses: astral-sh/setup-uv@v6
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Install dependencies
+        run: uv sync --group dev
+
+      - name: Run tests
+        run: uv run pytest

wordlevel-0.0.1a2/.gitignore

@@ -0,0 +1,225 @@
+# Created by https://www.toptal.com/developers/gitignore/api/python,macos
+# Edit at https://www.toptal.com/developers/gitignore?templates=python,macos
+
+### macOS ###
+# General
+.DS_Store
+.AppleDouble
+.LSOverride
+
+# Icon must end with two \r
+Icon
+
+
+# Thumbnails
+._*
+
+# Files that might appear in the root of a volume
+.DocumentRevisions-V100
+.fseventsd
+.Spotlight-V100
+.TemporaryItems
+.Trashes
+.VolumeIcon.icns
+.com.apple.timemachine.donotpresent
+
+# Directories potentially created on remote AFP share
+.AppleDB
+.AppleDesktop
+Network Trash Folder
+Temporary Items
+.apdisk
+
+### macOS Patch ###
+# iCloud generated files
+*.icloud
+
+### Python ###
+# 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/
+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
+*.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
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .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
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# 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/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+### Python Patch ###
+# Poetry local configuration file - https://python-poetry.org/docs/configuration/#local-configuration
+poetry.toml
+
+# ruff
+.ruff_cache/
+
+# LSP config files
+pyrightconfig.json
+
+# AI automations
+.claude/
+
+# Version file (auto-generated by hatch-vcs)
+src/wordlevel/_version.py
+
+# Lexicon data
+lexicons/*/data/
+
+# Auto-generated documentation
+/docs/documentation/api/
+/zensical-build.toml
+
+# Local drafting/scratch data
+drafting/
+
+# End of https://www.toptal.com/developers/gitignore/api/python,macos

wordlevel-0.0.1a2/.pre-commit-config.yaml

@@ -0,0 +1,16 @@
+repos:
+  - repo: https://github.com/astral-sh/ruff-pre-commit
+    rev: v0.12.8
+    hooks:
+      - id: ruff-check
+        exclude: ^docs/snippets/
+      - id: ruff-format
+        exclude: ^docs/snippets/
+  - repo: local
+    hooks:
+      - id: pyright
+        name: pyright
+        entry: uv run pyright
+        language: system
+        types: [python]
+        pass_filenames: false

wordlevel-0.0.1a2/LICENSE

@@ -0,0 +1,7 @@
+Copyright 2026 Ryan J. Gallagher
+
+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.