refactor(config,lint): centralize env utils, switch to ruff.isort, drop unused constants

- remove `isort` in favour of `ruff.lint.isort`
- remove unused constants `BASE_DIR` and `TEMPLATE_DIR` in `tests/test_flow_integration.py`
- rename constant `templates` to `JINJA_TEMPLATES` in `src/server/server_config.py`
- move function definition of `_get_int_env_var` from `src/server/server_config.py` to `src/gitingest/utils/config_utils.py`
- remove duplicated function definition of `_get_int_env_var` in `src/gitingest/config.py`
- rename function `_get_env_var` to `_get_str_env_var` for clarity
- move `Colors` from `src/server/server_utils.py` to `src/gitingest/utils/colors.py` to break circular import chain

Author: filipchristiansen

.pre-commit-config.yaml

@@ -58,12 +58,6 @@ repos:
       - id: python-use-type-annotations
         description: 'Enforce that python3.6+ type annotations are used instead of type comments.'
 
-  - repo: https://github.com/PyCQA/isort
-    rev: 6.0.1
-    hooks:
-      - id: isort
-        description: 'Sort imports alphabetically, and automatically separated into sections and by type.'
-
   - repo: https://github.com/pre-commit/mirrors-eslint
     rev: v9.30.1
     hooks:

pyproject.toml

@@ -100,22 +100,13 @@ per-file-ignores = { "tests/**/*.py" = ["S101"] } # Skip the "assert used" warni
 [tool.ruff.lint.pylint]
 max-returns = 10
 
-# [tool.ruff.lint.isort]
-# order-by-type = true
-# case-sensitive = true
+[tool.ruff.lint.isort]
+order-by-type = true
+case-sensitive = true
 
 [tool.pycln]
 all = true
 
-# TODO: Remove this once we figure out how to use ruff-isort
-[tool.isort]
-profile = "black"
-line_length = 119
-remove_redundant_aliases = true
-float_to_top = true  # https://github.com/astral-sh/ruff/issues/6514
-order_by_type = true
-filter_files = true
-
 # Test configuration
 [tool.pytest.ini_options]
 pythonpath = ["src"]

src/gitingest/__main__.py

@@ -9,7 +9,7 @@
 import click
 from typing_extensions import Unpack
 
-from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILE_SIZE, MAX_FILES, MAX_TOTAL_SIZE_BYTES, OUTPUT_FILE_NAME
+from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILES, MAX_FILE_SIZE, MAX_TOTAL_SIZE_BYTES, OUTPUT_FILE_NAME
 from gitingest.entrypoint import ingest_async
 
 

src/gitingest/config.py

@@ -3,15 +3,7 @@
 import tempfile
 from pathlib import Path
 
-from gitingest.utils.config_utils import _get_env_var
-
-def _get_int_env_var(key: str, default: int) -> int:
-    """Get environment variable as integer with fallback to default."""
-    try:
-        return int(_get_env_var(key, str(default)))
-    except ValueError:
-        print(f"Warning: Invalid value for GITINGEST_{key}. Using default: {default}")
-        return default
+from gitingest.utils.config_utils import _get_int_env_var, _get_str_env_var
 
 MAX_FILE_SIZE = _get_int_env_var("MAX_FILE_SIZE", 10 * 1024 * 1024)  # Max file size to process in bytes (10 MB)
 MAX_FILES = _get_int_env_var("MAX_FILES", 10_000)  # Max number of files to process
@@ -20,5 +12,5 @@ def _get_int_env_var(key: str, default: int) -> int:
 
 DEFAULT_TIMEOUT = _get_int_env_var("DEFAULT_TIMEOUT", 60)  # Default timeout for git operations in seconds
 
-OUTPUT_FILE_NAME = _get_env_var("OUTPUT_FILE_NAME", "digest.txt")
-TMP_BASE_PATH = Path(_get_env_var("TMP_BASE_PATH", tempfile.gettempdir())) / "gitingest"
+OUTPUT_FILE_NAME = _get_str_env_var("OUTPUT_FILE_NAME", "digest.txt")
+TMP_BASE_PATH = Path(_get_str_env_var("TMP_BASE_PATH", tempfile.gettempdir())) / "gitingest"

src/gitingest/schemas/ingestion.py

@@ -7,7 +7,7 @@
 
 from pydantic import BaseModel, Field
 
-from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILE_SIZE, MAX_FILES, MAX_TOTAL_SIZE_BYTES
+from gitingest.config import MAX_DIRECTORY_DEPTH, MAX_FILES, MAX_FILE_SIZE, MAX_TOTAL_SIZE_BYTES
 
 
 @dataclass

src/gitingest/utils/colors.py

@@ -0,0 +1,30 @@
+"""Color printing utility."""
+
+
+class Colors:
+    """ANSI color codes."""
+
+    BLACK = "\033[0;30m"
+    RED = "\033[0;31m"
+    GREEN = "\033[0;32m"
+    BROWN = "\033[0;33m"
+    BLUE = "\033[0;34m"
+    PURPLE = "\033[0;35m"
+    CYAN = "\033[0;36m"
+    LIGHT_GRAY = "\033[0;37m"
+    DARK_GRAY = "\033[1;30m"
+    LIGHT_RED = "\033[1;31m"
+    LIGHT_GREEN = "\033[1;32m"
+    YELLOW = "\033[1;33m"
+    LIGHT_BLUE = "\033[1;34m"
+    LIGHT_PURPLE = "\033[1;35m"
+    LIGHT_CYAN = "\033[1;36m"
+    WHITE = "\033[1;37m"
+    BOLD = "\033[1m"
+    FAINT = "\033[2m"
+    ITALIC = "\033[3m"
+    UNDERLINE = "\033[4m"
+    BLINK = "\033[5m"
+    NEGATIVE = "\033[7m"
+    CROSSED = "\033[9m"
+    END = "\033[0m"

src/gitingest/utils/config_utils.py

@@ -3,10 +3,11 @@
 from __future__ import annotations
 
 import os
+import warnings
 
 
-def _get_env_var(key: str, default: str) -> str:
-    """Get environment variable with ``GITINGEST_`` prefix.
+def _get_str_env_var(key: str, default: str) -> str:
+    """Get string environment variable with ``GITINGEST_`` prefix and fallback to default.
 
     Parameters
     ----------
@@ -18,13 +19,35 @@ def _get_env_var(key: str, default: str) -> str:
     Returns
     -------
     str
-        The value of the environment variable as a string.
+        The value of the environment variable.
 
     """
-    env_key = f"GITINGEST_{key}"
-    value = os.environ.get(env_key)
+    value = os.environ.get(f"GITINGEST_{key}")
 
     if value is None:
         return default
 
     return value
+
+
+def _get_int_env_var(key: str, default: int) -> int:
+    """Get integer environment variable with ``GITINGEST_`` prefix and fallback to default.
+
+    Parameters
+    ----------
+    key : str
+        The name of the environment variable.
+    default : int
+        The default value to return if the environment variable is not set.
+
+    Returns
+    -------
+    int
+        The value of the environment variable as an integer.
+
+    """
+    try:
+        return int(_get_str_env_var(key, default=str(default)))
+    except ValueError:
+        warnings.warn(f"Invalid value for GITINGEST_{key}. Using default: {default}", stacklevel=2)
+        return default

src/gitingest/utils/git_utils.py

@@ -12,9 +12,9 @@
 import httpx
 from starlette.status import HTTP_200_OK, HTTP_401_UNAUTHORIZED, HTTP_403_FORBIDDEN, HTTP_404_NOT_FOUND
 
+from gitingest.utils.colors import Colors
 from gitingest.utils.compat_func import removesuffix
 from gitingest.utils.exceptions import InvalidGitHubTokenError
-from server.server_utils import Colors
 
 # GitHub Personal-Access tokens (classic + fine-grained).
 #   - ghp_ / gho_ / ghu_ / ghs_ / ghr_  → 36 alphanumerics

src/server/main.py

@@ -16,7 +16,7 @@
 
 from server.metrics_server import start_metrics_server
 from server.routers import dynamic, index, ingest
-from server.server_config import templates
+from server.server_config import JINJA_TEMPLATES
 from server.server_utils import lifespan, limiter, rate_limit_exception_handler
 
 # Load environment variables from .env file
@@ -163,7 +163,7 @@ async def custom_swagger_ui(request: Request) -> HTMLResponse:
     - **HTMLResponse**: Custom Swagger UI documentation page
 
     """
-    return templates.TemplateResponse("swagger_ui.jinja", {"request": request})
+    return JINJA_TEMPLATES.TemplateResponse("swagger_ui.jinja", {"request": request})
 
 
 @app.get("/api", include_in_schema=True)

src/server/query_processor.py

@@ -8,10 +8,11 @@
 from gitingest.clone import clone_repo
 from gitingest.ingestion import ingest_query
 from gitingest.query_parser import IngestionQuery, parse_query
+from gitingest.utils.colors import Colors
 from gitingest.utils.git_utils import validate_github_token
 from server.models import IngestErrorResponse, IngestResponse, IngestSuccessResponse
 from server.server_config import MAX_DISPLAY_SIZE
-from server.server_utils import Colors, log_slider_to_size
+from server.server_utils import log_slider_to_size
 
 
 async def process_query(