feat: module renaming (#8)

* feat: project module renamed to epa_syllabifier

README.md, tests, code and all names related with module has been changed

* fix(Makefile): adds a pip installation of module with edit mode

* fix: undo changelog deletion

* docs(README.md): minor changes

Author: ssoto

CHANGELOG.md

@@ -36,4 +36,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Fix
 
 - empty case and Makefile improvements(#5)
-- minors and black over the code
+- minors and black over the code

Makefile

@@ -1,4 +1,4 @@
-# Makefile for the epa-syllabicate project
+# Makefile for the epa-syllabifier project
 
 .PHONY: help install install-dev test test-verbose test-coverage clean format lint all venv activate
 
@@ -67,6 +67,8 @@ install-dev: ensure-venv ## Install development dependencies
 	@echo "$(GREEN)Installing development dependencies...$(NC)"
 	$(VENV_PIP) install -e ".[dev]"
 	@echo "$(YELLOW)Using virtual environment: $(VENV_DIR)$(NC)"
+	# add module install using editable mode
+	$(VENV_PIP) install -e ".[dev]"
 
 test: install-dev ## Run all tests
 	@echo "$(GREEN)Running tests...$(NC)"
@@ -92,10 +94,10 @@ test-coverage: install-dev ## Run tests with code coverage
 	@echo "$(GREEN)Running tests with coverage...$(NC)"
 	@if [ -d "$(VENV_DIR)" ]; then \
 		echo "$(BLUE)Using virtual environment: $(VENV_DIR)$(NC)"; \
-		$(VENV_PYTHON) -m pytest --cov=epa_syllabicate --cov-report=html --cov-report=term tests/; \
+		$(VENV_PYTHON) -m pytest --cov=epa_syllabifier --cov-report=html --cov-report=term tests/; \
 	else \
 		echo "$(YELLOW)No virtual environment found, using system Python$(NC)"; \
-		$(PYTHON) -m pytest --cov=epa_syllabicate --cov-report=html --cov-report=term tests/; \
+		$(PYTHON) -m pytest --cov=epa_syllabifier --cov-report=html --cov-report=term tests/; \
 	fi
 
 test-watch: install-dev ## Run tests in watch mode (requires pytest-watch)
@@ -112,20 +114,20 @@ format: ## Format code with black
 	@echo "$(GREEN)Formatting code...$(NC)"
 	@if [ -d "$(VENV_DIR)" ]; then \
 		echo "$(BLUE)Using virtual environment: $(VENV_DIR)$(NC)"; \
-		$(VENV_PYTHON) -m black epa_syllabicate/ tests/; \
+		$(VENV_PYTHON) -m black epa_syllabifier/ tests/; \
 	else \
 		echo "$(YELLOW)No virtual environment found, using system Python$(NC)"; \
-		$(PYTHON) -m black epa_syllabicate/ tests/; \
+		$(PYTHON) -m black epa_syllabifier/ tests/; \
 	fi
 
 lint: ## Check code format
 	@echo "$(GREEN)Checking code format...$(NC)"
 	@if [ -d "$(VENV_DIR)" ]; then \
 		echo "$(BLUE)Using virtual environment: $(VENV_DIR)$(NC)"; \
-		$(VENV_PYTHON) -m black --check epa_syllabicate/ tests/; \
+		$(VENV_PYTHON) -m black --check epa_syllabifier/ tests/; \
 	else \
 		echo "$(YELLOW)No virtual environment found, using system Python$(NC)"; \
-		$(PYTHON) -m black --check epa_syllabicate/ tests/; \
+		$(PYTHON) -m black --check epa_syllabifier/ tests/; \
 	fi
 
 clean: ## Clean temporary files
@@ -171,7 +173,7 @@ quick-test: ## Quick test without detailed output
 	fi
 
 # Command to run a specific test
-# Usage: make test-file FILE=test_syllabicate.py
+# Usage: make test-file FILE=test_syllabifier.py
 test-file: install-dev ## Run a specific test file (use FILE=filename)
 	@echo "$(GREEN)Running $(FILE)...$(NC)"
 	@if [ -d "$(VENV_DIR)" ]; then \

README.md

@@ -1,16 +1,13 @@
-# EPA Syllabicate
+# EPA Syllabifier
 
 Módulo Python para la silabificación de palabras.
 
 ## Uso
 
 ```python
-from epa_syllabicate import syllabicate
-
-# Ejemplo de uso
-word = "ehemplo"
-silabes = syllabicate(word)
-print(silabas)  # ['e', 'hem', 'plo']
+>>> from epa_syllabifier import syllabify
+>>> syllabify("arcançía")
+['ar', 'can', 'çía']
 ```
 
 ## Desarrollo
@@ -20,11 +17,14 @@ print(silabas)  # ['e', 'hem', 'plo']
 Para contribuir al proyecto, primero clona el repositorio y luego instala las dependencias de desarrollo:
 
 ```bash
-git clone https://github.com/tu-usuario/epa-syllabicate.git
-cd epa-syllabicate
-python -m env .venv
-source .venv/bin/activate
-python -m pip install -e ".[dev]"
+git clone https://github.com/andalugeeks/epa-syllabifier.git
+cd epa-syllabifier
+
+# Configuración completa de desarrollo (crea venv e instala dependencias)
+make dev-setup
+
+# Ver comando para activar el entorno virtual
+make activate
 ```
 
 ### Ejecución de tests
@@ -33,10 +33,38 @@ Para ejecutar los tests:
 
 ```bash
 # Ejecutar todos los tests
-pytest
+make test
 
 # Ejecutar tests con cobertura
-pytest --cov=epa_syllabicate
+make test-coverage
+
+# Ejecutar tests con salida detallada
+make test-verbose
+
+# Ejecutar tests
+make quick-test
+```
+
+### Comandos útiles de desarrollo
+
+```bash
+# Ver todos los comandos disponibles
+make help
+
+# Formatear código con Black
+make format
+
+# Verificar formato del código
+make lint
+
+# Construir el paquete
+make build
+
+# Limpiar archivos temporales
+make clean
+
+# Configuración completa: limpieza + instalación + tests
+make all
 ```
 
 ## Requisitos

epa_syllabicate/__init__.py

@@ -0,0 +1,6 @@
+"""
+EPA Syllabifier - Módulo para silabificación de palabras
+"""
+from .syllabicator import syllabify
+
+all = ["syllabify"]

epa_syllabifier/__init__.py

@@ -3,14 +3,14 @@ requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
-name = "epa_syllabicate"
+name = "epa_syllabifier"
 version = "0.2.2"
 description = "Automatic syllabification module for Spanish words"
 readme = "README.md"
 requires-python = ">=3.8"
 license = "MIT"
 authors = [
-    { name = "EPA Team" }
+    { name = "Andalugeeks Team" }
 ]
 keywords = ["syllabification", "spanish", "nlp", "text-processing", "linguistics"]
 classifiers = [
@@ -31,9 +31,9 @@ classifiers = [
 dependencies = []
 
 [project.urls]
-"Homepage" = "https://github.com/andalugeeks/epa-syllabicate"
-"Bug Tracker" = "https://github.com/andalugeeks/epa-syllabicate/issues"
-"Repository" = "https://github.com/andalugeeks/epa-syllabicate.git"
+"Homepage" = "https://github.com/andalugeeks/epa-syllabifier"
+"Bug Tracker" = "https://github.com/andalugeeks/epa-syllabifier/issues"
+"Repository" = "https://github.com/andalugeeks/epa-syllabifier.git"
 
 [project.optional-dependencies]
 dev = [

epa_syllabicate/syllabicator.py epa_syllabifier/syllabicator.pyepa_syllabicate/syllabicator.py renamed to epa_syllabifier/syllabicator.py

@@ -1,3 +1,3 @@
 """
-Tests para el módulo epa_syllabicate
+Tests para el módulo epa_syllabifier
 """

pyproject.toml

@@ -5,10 +5,10 @@
 import unittest
 import csv
 import os
-from epa_syllabicate import syllabify
+from epa_syllabifier import syllabify
 
 
-class TestSyllabicate(unittest.TestCase):
+class TestSyllabifier(unittest.TestCase):
 
     @classmethod
     def setUpClass(cls):
@@ -75,7 +75,7 @@ def test_method(self):
             test_method = make_test(word, expected_syllables)
             test_method.__name__ = test_name
             test_method.__doc__ = f'Test para la palabra "{word}" -> {expected_syllables}'
-            setattr(TestSyllabicate, test_name, test_method)
+            setattr(TestSyllabifier, test_name, test_method)
 
 
 # Generate individual tests