refactor: refactor module names to avoid function/module name clashes (#114)

- Renamed: - `clone.py` → `repository_clone.py` - `ingest.py` → `repository_ingest.py` - `ingest_from_query.py` → `query_ingestion.py` - `parse_query.py` → `query_parser.py`

Author: filipchristiansen

src/gitingest/__init__.py

@@ -1,8 +1,8 @@
 """ Gitingest: A package for ingesting data from git repositories. """
 
-from gitingest.clone import clone_repo
-from gitingest.ingest import ingest
-from gitingest.ingest_from_query import run_ingest_query
-from gitingest.parse_query import parse_query
+from gitingest.query_ingestion import run_ingest_query
+from gitingest.query_parser import parse_query
+from gitingest.repository_clone import clone_repo
+from gitingest.repository_ingest import ingest
 
 __all__ = ["run_ingest_query", "clone_repo", "parse_query", "ingest"]

src/gitingest/cli.py

@@ -4,8 +4,8 @@
 
 import click
 
-from gitingest.ingest import ingest
-from gitingest.ingest_from_query import MAX_FILE_SIZE
+from gitingest.query_ingestion import MAX_FILE_SIZE
+from gitingest.repository_ingest import ingest
 
 
 @click.command()

src/gitingest/ingest_from_query.py renamed to src/gitingest/query_ingestion.py

@@ -5,9 +5,9 @@
 import shutil
 
 from config import TMP_BASE_PATH
-from gitingest.clone import CloneConfig, clone_repo
-from gitingest.ingest_from_query import run_ingest_query
-from gitingest.parse_query import parse_query
+from gitingest.query_ingestion import run_ingest_query
+from gitingest.query_parser import parse_query
+from gitingest.repository_clone import CloneConfig, clone_repo
 
 
 def ingest(

src/gitingest/parse_query.py renamed to src/gitingest/query_parser.py

@@ -7,9 +7,9 @@
 from starlette.templating import _TemplateResponse
 
 from config import EXAMPLE_REPOS, MAX_DISPLAY_SIZE
-from gitingest.clone import CloneConfig, clone_repo
-from gitingest.ingest_from_query import run_ingest_query
-from gitingest.parse_query import parse_query
+from gitingest.query_ingestion import run_ingest_query
+from gitingest.query_parser import parse_query
+from gitingest.repository_clone import CloneConfig, clone_repo
 from server_utils import Colors, log_slider_to_size
 
 templates = Jinja2Templates(directory="templates")

src/gitingest/clone.py renamed to src/gitingest/repository_clone.py

@@ -4,7 +4,7 @@
 from fastapi.responses import HTMLResponse
 from fastapi.templating import Jinja2Templates
 
-from process_query import process_query
+from query_processor import process_query
 from server_utils import limiter
 
 router = APIRouter()

src/gitingest/ingest.py renamed to src/gitingest/repository_ingest.py

@@ -5,7 +5,7 @@
 from fastapi.templating import Jinja2Templates
 
 from config import EXAMPLE_REPOS
-from process_query import process_query
+from query_processor import process_query
 from server_utils import limiter
 
 router = APIRouter()

src/process_query.py renamed to src/query_processor.py

@@ -1,10 +1,10 @@
-""" Tests for the ingest_from_query module """
+""" Tests for the query_ingestion module """
 
 from pathlib import Path
 from typing import Any
 from unittest.mock import patch
 
-from gitingest.ingest_from_query import _extract_files_content, _read_file_content, _scan_directory
+from gitingest.query_ingestion import _extract_files_content, _read_file_content, _scan_directory
 
 
 def test_scan_directory(temp_directory: Path, sample_query: dict[str, Any]) -> None:
@@ -42,8 +42,8 @@ def test_read_file_content_with_notebook(tmp_path: Path):
  notebook_path = tmp_path / "dummy_notebook.ipynb"
  notebook_path.write_text("{}", encoding="utf-8") # minimal JSON
 
- # Patch the symbol as it is used in ingest_from_query
- with patch("gitingest.ingest_from_query.process_notebook") as mock_process:
+ # Patch the symbol as it is used in query_ingestion
+ with patch("gitingest.query_ingestion.process_notebook") as mock_process:
  _read_file_content(notebook_path)
  mock_process.assert_called_once_with(notebook_path)
 
@@ -52,7 +52,7 @@ def test_read_file_content_with_non_notebook(tmp_path: Path):
  py_file_path = tmp_path / "dummy_file.py"
  py_file_path.write_text("print('Hello')", encoding="utf-8")
 
- with patch("gitingest.ingest_from_query.process_notebook") as mock_process:
+ with patch("gitingest.query_ingestion.process_notebook") as mock_process:
  _read_file_content(py_file_path)
  mock_process.assert_not_called()