esmorph 0.1.0__tar.gz

esmorph-0.1.0/.cargo/config.toml

@@ -0,0 +1,4 @@
+# Code that needs no dictionary is checked without `make dictionary`; a dependency from git does not
+# read this file
+[env]
+ESMORPH_EMPTY_DICTIONARY = "1"

esmorph-0.1.0/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,34 @@
+name: Bug report
+description: Wrong analysis, exception or crash
+labels: ["bug"]
+body:
+  - type: textarea
+    id: description
+    attributes:
+      label: What happens
+      description: What you expected and what you got
+    validations:
+      required: true
+  - type: textarea
+    id: reproduce
+    attributes:
+      label: How to reproduce
+      description: The word forms or minimal code that trigger the bug and the full traceback, if any
+      render: python
+    validations:
+      required: true
+  - type: input
+    id: version
+    attributes:
+      label: esMorph version
+      description: "`python -c \"import esmorph; print(esmorph.__version__)\"`"
+      placeholder: "0.1.0"
+    validations:
+      required: true
+  - type: input
+    id: environment
+    attributes:
+      label: Python and OS
+      placeholder: "Python 3.12, macOS 15"
+    validations:
+      required: true

esmorph-0.1.0/.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,5 @@
+blank_issues_enabled: true
+contact_links:
+  - name: Documentation
+    url: https://sergeyshk.github.io/esMorph/
+    about: Installation and use of the analyzer

esmorph-0.1.0/.github/ISSUE_TEMPLATE/feature_request.yml

@@ -0,0 +1,22 @@
+name: Feature request
+description: A new feature, missing words or an improvement
+labels: ["enhancement"]
+body:
+  - type: textarea
+    id: problem
+    attributes:
+      label: What problem does it solve
+      description: What you want to do and why the current features are not enough
+    validations:
+      required: true
+  - type: textarea
+    id: proposal
+    attributes:
+      label: Proposed solution
+      description: How it could look in the API - a method, a parameter
+  - type: checkboxes
+    id: contribution
+    attributes:
+      label: Contribution
+      options:
+        - label: I am willing to submit a pull request

esmorph-0.1.0/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,7 @@
+## What was done
+
+<!-- What changed and why. If the Python API, the analyses or the dictionary format change, say so explicitly: it goes into the release notes. If the pull request closes an issue: Closes #123 -->
+
+## Verification
+
+<!-- How it was checked: tests (what exactly they verify), `make lint`, `make test-cov`, `make docs-build` if the documentation changed. Reminder: the documentation and README are bilingual - `docs/*.md` + `docs/*.es.md`, `README.md` + `README.es.md` -->

esmorph-0.1.0/.github/dependabot.yml

@@ -0,0 +1,30 @@
+version: 2
+updates:
+  - package-ecosystem: "uv"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    groups:
+      python-dependencies:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  - package-ecosystem: "cargo"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    open-pull-requests-limit: 5
+    labels: ["dependencies"]
+    groups:
+      rust-dependencies:
+        patterns: ["*"]
+        update-types: ["minor", "patch"]
+
+  - package-ecosystem: "github-actions"
+    directory: "/"
+    schedule:
+      interval: "monthly"
+    groups:
+      github-actions:
+        patterns: ["*"]

esmorph-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,155 @@
+name: build
+
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+
+permissions:
+  contents: read
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  lint:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Setup uv
+        uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          enable-cache: true
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 # master
+        with:
+          toolchain: stable
+          components: rustfmt, clippy
+      - name: Cache Rust
+        uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - name: Install dependencies
+        run: uv sync --locked --no-default-groups --group lint --no-install-project
+      - name: Ruff
+        run: |
+          uv run --no-sync ruff check python scripts tests
+          uv run --no-sync ruff format python scripts tests --check
+      - name: Ruff format of the Python in Markdown
+        run: git ls-files -z '*.md' | xargs -0 uv run --no-sync ruff format --check
+      - name: Mypy
+        run: uv run --no-sync mypy
+      - name: Rustfmt
+        run: cargo fmt --all --check
+      - name: Clippy
+        run: |
+          cargo clippy --workspace --all-targets --locked -- -D warnings
+          # The workspace turns on the feature build: the module builds the core without it
+          cargo clippy -p esmorph --no-default-features --locked -- -D warnings
+      - name: Rustdoc
+        run: cargo doc --no-deps --all-features -p esmorph -p esmorph-dict-es --locked
+        env:
+          RUSTDOCFLAGS: -D warnings
+
+  test:
+    name: test (${{ matrix.python-version }}${{ matrix.os != 'ubuntu-latest' && format(', {0}', matrix.os) || '' }})
+    runs-on: ${{ matrix.os }}
+    timeout-minutes: 30
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest]
+        python-version: ["3.11", "3.12", "3.13", "3.14", "3.15"]
+        include:
+          - os: ubuntu-latest
+            python-version: "3.14t"
+          - os: windows-latest
+            python-version: "3.12"
+          - os: macos-latest
+            python-version: "3.12"
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Setup uv
+        uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          enable-cache: true
+          python-version: ${{ matrix.python-version }}
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 # master
+        with:
+          toolchain: stable
+      - name: Cache Rust
+        uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - name: Install dependencies
+        run: uv sync --locked --no-default-groups --group test
+      - name: Cache Wiktionary
+        # The snapshot of Wiktionary from Hugging Face is downloaded once per version of the script
+        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+        with:
+          path: build/wiktionary/raw
+          key: wiktionary-${{ hashFiles('scripts/export_wiktionary.py') }}
+          # On Windows the hash of a script with CRLF differs: any earlier cache fits, the download checks SHA-256
+          restore-keys: wiktionary-
+          enableCrossOsArchive: true
+      - name: Cache treebanks
+        # The training parts of the treebanks from GitHub are downloaded once per version of the script
+        uses: actions/cache@55cc8345863c7cc4c66a329aec7e433d2d1c52a9 # v6.1.0
+        with:
+          path: build/ud/raw
+          key: ud-${{ hashFiles('scripts/export_ud.py') }}
+          # On Windows the hash of a script with CRLF differs: any earlier cache fits, the download checks SHA-256
+          restore-keys: ud-
+          enableCrossOsArchive: true
+      - name: Build dictionary
+        shell: bash
+        run: |
+          uv run --no-sync python scripts/export_wiktionary.py build/wiktionary
+          uv run --no-sync python scripts/export_ud.py build/ud
+          cargo run --release --locked -p esmorph-build -- build/wiktionary build/ud python/esmorph/data/es.dict
+          uv run --no-sync python -c "import hashlib; print(hashlib.sha256(open('python/esmorph/data/es.dict', 'rb').read()).hexdigest())"
+      - name: Check dictionary size
+        # The dictionary goes to crates.io in the archive of the crate esmorph-dict-es, whose limit is
+        # 10 MiB: a pull request changing only the scripts of the dictionary sees it here, not on a release tag
+        if: matrix.os == 'ubuntu-latest' && matrix.python-version == '3.12'
+        run: |
+          size="$(gzip -9 -c python/esmorph/data/es.dict | wc -c)"
+          echo "es.dict compressed: $size bytes"
+          [ "$size" -lt 10420224 ] || { echo "The compressed dictionary does not fit the crates.io limit of 10 MiB"; exit 1; }
+      - name: Run tests
+        run: uv run --no-sync pytest --cov esmorph
+      - name: Run Rust tests
+        run: cargo test -p esmorph -p esmorph-dict-es -p esmorph-build --all-features --locked
+
+  msrv:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Setup Rust
+        uses: dtolnay/rust-toolchain@683b588c487a69d01f6c6ddf40f036ff682cc2c8 # master
+        with:
+          toolchain: "1.88"
+      - name: Cache Rust
+        uses: Swatinem/rust-cache@d1527c8f67ef9af357290475d4af4b0fab8f12e0 # v2.9.3
+      - name: Check
+        run: cargo check --workspace --all-targets --locked
+
+  docs:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+      - name: Setup uv
+        uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          enable-cache: true
+          python-version: "3.13"
+      - name: Install dependencies
+        run: uv sync --locked --only-group docs
+      - name: Build docs
+        run: uv run --no-sync mkdocs build --strict

esmorph-0.1.0/.github/workflows/docs.yml

@@ -0,0 +1,37 @@
+name: docs
+
+# The site describes the released version: it is published on a release tag, not from master
+on:
+  push:
+    tags:
+      - "[0-9]+.[0-9]+.[0-9]+"
+  workflow_dispatch:
+
+concurrency:
+  group: docs
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout
+        uses: actions/checkout@3d3c42e5aac5ba805825da76410c181273ba90b1 # v7.0.1
+        with:
+          fetch-depth: 0
+      - name: Setup uv
+        uses: astral-sh/setup-uv@68559e99cc807c1eb7e9238fd43a15bba460eec2 # v10.3.3
+        with:
+          enable-cache: true
+          python-version: "3.13"
+      - name: Install dependencies
+        run: uv sync --locked --only-group docs
+      - name: Configure git
+        run: |
+          git config user.name "github-actions[bot]"
+          git config user.email "41898282+github-actions[bot]@users.noreply.github.com"
+      - name: Deploy
+        run: uv run --no-sync mkdocs gh-deploy --force --strict