refactor: Update pre-commit hook and refactor project structure

refactor: Update pre-commit hook and refactor project structure

.pre-commit-hooks.yaml

@@ -3,4 +3,4 @@
   description: >
     Keep your code snippets in README up-to-date!
   entry: code-embedder
-  language: python
+  language: system

Makefile

@@ -5,7 +5,7 @@ build:
 
 run:
 	make build
-	docker run --rm -it --env-file=.env code-embedder
+	docker run --rm -it code-embedder
 
 test:
 	poetry run pytest

README.md

@@ -111,7 +111,7 @@ Your `.pre-commit-config.yaml` file should look like this:
     - id: code-embedder
       name: Code embedder
       entry: code-embedder run
-      language: python
+      language: system
 ```
 
 ### B. Direct repository reference
@@ -123,7 +123,7 @@ Alternatively, you can reference the repository directly in your `.pre-commit-co
     - id: code-embedder
       name: Code embedder
       entry: code-embedder run
-      language: python
+      language: system
 ```
 
 ### 🔧 Options

src/code_embedding.py → code_embedder/code_embedding.py

@@ -1,8 +1,8 @@
 from loguru import logger
 
-from src.script_content_reader import ScriptContentReaderInterface
-from src.script_metadata import ScriptMetadata
-from src.script_metadata_extractor import ScriptMetadataExtractorInterface
+from code_embedder.script_content_reader import ScriptContentReaderInterface
+from code_embedder.script_metadata import ScriptMetadata
+from code_embedder.script_metadata_extractor import ScriptMetadataExtractorInterface
 
 
 class CodeEmbedder:

src/main.py → code_embedder/main.py

@@ -4,9 +4,9 @@
 import typer
 from loguru import logger
 
-from src.code_embedding import CodeEmbedder
-from src.script_content_reader import ScriptContentReader
-from src.script_metadata_extractor import ScriptMetadataExtractor
+from code_embedder.code_embedding import CodeEmbedder
+from code_embedder.script_content_reader import ScriptContentReader
+from code_embedder.script_metadata_extractor import ScriptMetadataExtractor
 
 logger.remove()
 logger.add(sys.stderr, level="ERROR")

src/script_content_reader.py → code_embedder/script_content_reader.py

@@ -2,7 +2,7 @@
 import re
 from typing import Protocol
 
-from src.script_metadata import ScriptMetadata
+from code_embedder.script_metadata import ScriptMetadata
 
 
 class ScriptContentReaderInterface(Protocol):

src/script_metadata_extractor.py → code_embedder/script_metadata_extractor.py

@@ -1,7 +1,7 @@
 import re
 from typing import Protocol
 
-from src.script_metadata import ScriptMetadata
+from code_embedder.script_metadata import ScriptMetadata
 
 
 class ScriptMetadataExtractorInterface(Protocol):

entrypoint.sh

@@ -8,9 +8,9 @@ BRANCH_NAME=${GITHUB_HEAD_REF:-$GITHUB_REF_NAME}
 
 git pull origin ${BRANCH_NAME}
 
-echo "Searching for code snippets in $README_PATHS..."
+echo "Searching for code snippets..."
 
-poetry run python /app/src/main.py
+poetry run python /app/code_embedder/main.py
 
 if [ $? -ne 0 ]; then
     exit 1

pyproject.toml

@@ -5,10 +5,9 @@ description = "Embed python code from script to markdown"
 authors = ["Katerina Vankova <katerinavankova1@gmail.com>"]
 readme = "README.md"
 license = "MIT"
-packages = [{include = "src"}]
 
 [tool.poetry.scripts]
-code-embedder = "src.main:app"
+code-embedder = "code_embedder.main:app"
 
 [tool.poetry.dependencies]
 python = "^3.11"

tests/test_code_embedding.py

@@ -2,9 +2,9 @@
 
 import pytest
 
-from src.code_embedding import CodeEmbedder
-from src.script_content_reader import ScriptContentReader
-from src.script_metadata_extractor import ScriptMetadataExtractor
+from code_embedder.code_embedding import CodeEmbedder
+from code_embedder.script_content_reader import ScriptContentReader
+from code_embedder.script_metadata_extractor import ScriptMetadataExtractor
 
 
 @pytest.mark.parametrize(

tests/test_script_content_reader.py

@@ -2,8 +2,8 @@
 
 import pytest
 
-from src.script_content_reader import ScriptContentReader
-from src.script_metadata import ScriptMetadata
+from code_embedder.script_content_reader import ScriptContentReader
+from code_embedder.script_metadata import ScriptMetadata
 
 
 def create_script_metadata(

tests/test_script_metadata_extractor.py

@@ -2,8 +2,8 @@
 
 import pytest
 
-from src.script_metadata import ScriptMetadata
-from src.script_metadata_extractor import ScriptMetadataExtractor
+from code_embedder.script_metadata import ScriptMetadata
+from code_embedder.script_metadata_extractor import ScriptMetadataExtractor
 
 
 def create_script_metadata(