refactor: refactor codebase to unify server module and update file paths (#142)

* Refactor project into a dedicated 'server' module and update all references accordingly

---------

Co-authored-by: Romain Courtois <romain@coderamp.io>

Author: filipchristiansen

CONTRIBUTING.md

@@ -48,18 +48,18 @@ Thanks for your interest in contributing to Gitingest! 🚀 Gitingest aims to be
    pytest
    ```
 
-8. Run the app locally using Docker to test your changes (optional):
+8. Navigate to src folder
 
    1. Build the Docker image
 
         ``` bash
-        docker build -t gitingest .
+        cd src
         ```
 
-   2. Run the Docker container:
+   2. Run the local web server:
 
       ``` bash
-      docker run -d --name gitingest -p 8000:8000 gitingest
+      uvicorn server.main:app
       ```
 
    3. Open your browser and navigate to `http://localhost:8000` to see the app running.

Dockerfile

@@ -41,4 +41,4 @@ USER appuser
 
 EXPOSE 8000
 
-CMD ["python", "-m", "uvicorn", "main:app", "--host", "0.0.0.0", "--port", "8000"]
+CMD ["python", "-m", "uvicorn", "server.main:app", "--host", "0.0.0.0", "--port", "8000"]

src/gitingest/cli.py

@@ -6,7 +6,7 @@
 
 import click
 
-from config import MAX_FILE_SIZE, OUTPUT_FILE_PATH
+from gitingest.config import MAX_FILE_SIZE, OUTPUT_FILE_PATH
 from gitingest.repository_ingest import ingest
 
 

src/gitingest/config.py

@@ -0,0 +1,11 @@
+""" Configuration file for the project. """
+
+from pathlib import Path
+
+MAX_FILE_SIZE = 10 * 1024 * 1024  # 10 MB
+MAX_DIRECTORY_DEPTH = 20  # Maximum depth of directory traversal
+MAX_FILES = 10_000  # Maximum number of files to process
+MAX_TOTAL_SIZE_BYTES = 500 * 1024 * 1024  # 500 MB
+
+OUTPUT_FILE_PATH = "digest.txt"
+TMP_BASE_PATH = Path("/tmp/gitingest")

src/gitingest/query_ingestion.py

@@ -6,7 +6,7 @@
 
 import tiktoken
 
-from config import MAX_DIRECTORY_DEPTH, MAX_FILES, MAX_TOTAL_SIZE_BYTES
+from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILES, MAX_TOTAL_SIZE_BYTES
 from gitingest.exceptions import (
     AlreadyVisitedError,
     InvalidNotebookError,

src/gitingest/query_parser.py

@@ -9,7 +9,7 @@
 from pathlib import Path
 from urllib.parse import unquote, urlparse
 
-from config import MAX_FILE_SIZE, TMP_BASE_PATH
+from gitingest.config import MAX_FILE_SIZE, TMP_BASE_PATH
 from gitingest.exceptions import InvalidPatternError
 from gitingest.ignore_patterns import DEFAULT_IGNORE_PATTERNS
 from gitingest.repository_clone import _check_repo_exists, fetch_remote_branch_list
@@ -163,7 +163,7 @@ async def _parse_repo_source(source: str) -> ParsedQuery:
 
     _id = str(uuid.uuid4())
     slug = f"{user_name}-{repo_name}"
-    local_path = Path(TMP_BASE_PATH) / _id / slug
+    local_path = TMP_BASE_PATH / _id / slug
     url = f"https://{host}/{user_name}/{repo_name}"
 
     parsed = ParsedQuery(

src/gitingest/repository_ingest.py

@@ -4,7 +4,7 @@
 import inspect
 import shutil
 
-from config import TMP_BASE_PATH
+from gitingest.config import TMP_BASE_PATH
 from gitingest.query_ingestion import run_ingest_query
 from gitingest.query_parser import ParsedQuery, parse_query
 from gitingest.repository_clone import CloneConfig, clone_repo

src/routers/__init__.py

@@ -10,10 +10,9 @@
 from slowapi.errors import RateLimitExceeded
 from starlette.middleware.trustedhost import TrustedHostMiddleware
 
-from config import templates
-from routers import download, dynamic, index
-from server_utils import limiter
-from utils import lifespan, rate_limit_exception_handler
+from server.routers import download, dynamic, index
+from server.server_config import templates
+from server.server_utils import lifespan, limiter, rate_limit_exception_handler
 
 # Load environment variables from .env file
 load_dotenv()