Skip to content

feat: imlements syllabify of EPA text and files#23

Open
ssoto wants to merge 2 commits intomasterfrom
feat/adds-epa-syllabifier
Open

feat: imlements syllabify of EPA text and files#23
ssoto wants to merge 2 commits intomasterfrom
feat/adds-epa-syllabifier

Conversation

@ssoto
Copy link
Copy Markdown
Contributor

@ssoto ssoto commented Jul 6, 2025

This pull request introduces several enhancements and new features to the Makefile and project configuration, primarily focused on improving dependency management, adding new CLI tools, and updating documentation. The most significant changes include the addition of a syllabification tool (syllabify), updates to the Makefile for better development workflows, and updates to the project dependencies and documentation.

Enhancements to the Makefile:

  • Added new targets: sync-dev, install-editable, demo-transliterate, demo-syllabify, and add-dep to streamline development workflows and support new features. For example, sync-dev handles development dependencies, and add-dep simplifies adding dependencies to pyproject.toml. ([[1]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L1-R3), [[2]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L18-R37), [[3]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52R127-R144))
  • Modified the test target to use sync-dev instead of sync for better dependency synchronization during testing. ([MakefileL50-R60](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L50-R60))

New CLI Tool: Syllabifier

  • Introduced the syllabify CLI tool for syllabifying words using EPA rules. This includes updates to the Makefile (demo-syllabify target) and documentation in README.md. ([[1]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-76ed074a9305c04054cdebb9e9aad2d818052b07091de1f20cad0bbac34ffb52L76-R105), [[2]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R59-R90))

Dependency and Configuration Updates:

  • Added epa-syllabifier as a dependency in pyproject.toml and dev-requirements.txt. Updated pyproject.toml to include the syllabify script under script-files. ([[1]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-43470c4f399e798afc682f0bf6c690eef5f47ee25445904a066e4c3314f3a787R17-R18), [[2]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711R27-R29), [[3]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-50c86b7ed8ac2cf95bd48334961bf0530cdc77b5a56f852c5c61b89d735fd711L46-R52))

Documentation Improvements:

  • Updated README.md to include instructions for the new syllabify tool and examples for transliterating files using the andaluh CLI. ([[1]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5L35-R35), [[2]](https://github.com/andalugeeks/andaluh-py/pull/23/files#diff-b335630551682c19a781afebcf4d07bf978fb1f8ac04c6bf87428ed5106870f5R59-R90))

@ssoto ssoto requested a review from Copilot July 6, 2025 11:34
@ssoto ssoto self-assigned this Jul 6, 2025
@ssoto ssoto requested a review from fontanon July 6, 2025 11:34
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull Request Overview

This PR adds an EPA-based syllabification CLI, improves dependency workflows in the Makefile, and updates project configuration and documentation accordingly.

  • Introduce syllabify script and add epa-syllabifier dependency
  • Add new Makefile targets (sync-dev, install-editable, demo-transliterate, demo-syllabify, add-dep) and update test to use sync-dev
  • Update pyproject.toml, dev-requirements.txt, and README.md to reflect the new tool and workflows

Reviewed Changes

Copilot reviewed 4 out of 5 changed files in this pull request and generated 3 comments.

File Description
pyproject.toml Added epa-syllabifier to dependencies and included bin/syllabify in script-files
dev-requirements.txt Added epa-syllabifier==0.3.0 under development requirements
README.md Clarified CLI usage, added file transliteration example, and documented the new syllabify tool
Makefile Set default goal, added sync-dev, install-editable, demo-* targets, updated test to use sync-dev, and introduced add-dep
Comments suppressed due to low confidence (1)

README.md:59

  • [nitpick] Rephrase to 'You can also transliterate files using the -i option:' for smoother English phrasing.
You also can transliterate files using the `-i` option:

Comment thread Makefile Outdated
Comment thread Makefile
Comment on lines +33 to +36
install-editable: check-uv sync ## Instala el módulo andaluh en modo desarrollo
@echo "⚙️ Instalando módulo andaluh en modo desarrollo..."
@uv pip install -e .
@echo "✅ Módulo andaluh instalado en modo desarrollo"
Copy link

Copilot AI Jul 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[nitpick] The 'install-editable' target duplicates the 'install' target. Consider consolidating these to avoid duplicated logic.

Suggested change
install-editable: check-uv sync ## Instala el módulo andaluh en modo desarrollo
@echo "⚙️ Instalando módulo andaluh en modo desarrollo..."
@uv pip install -e .
@echo "✅ Módulo andaluh instalado en modo desarrollo"
install-editable: install ## Alias para instalar el módulo andaluh en modo desarrollo

Copilot uses AI. Check for mistakes.
Comment thread Makefile
@uv pip install -e .
@echo "✅ Módulo andaluh instalado en modo desarrollo"

install-editable: check-uv sync ## Instala el módulo andaluh en modo desarrollo
Copy link

Copilot AI Jul 6, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The 'install-editable' target depends on 'sync', which no longer installs development dependencies. You may want to depend on 'sync-dev' instead to ensure dev dependencies are available.

Suggested change
install-editable: check-uv sync ## Instala el módulo andaluh en modo desarrollo
install-editable: check-uv sync-dev ## Instala el módulo andaluh en modo desarrollo

Copilot uses AI. Check for mistakes.
Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants