Skip to content

Refactor code structure for improved readability and maintainability#81

Merged
VaitaR merged 1 commit into
mainfrom
update/add-pyproject
Dec 13, 2025
Merged

Refactor code structure for improved readability and maintainability#81
VaitaR merged 1 commit into
mainfrom
update/add-pyproject

Conversation

@VaitaR
Copy link
Copy Markdown
Owner

@VaitaR VaitaR commented Dec 13, 2025

No description provided.

@VaitaR VaitaR merged commit a5d40b9 into main Dec 13, 2025
4 checks passed
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

💡 Codex Review

Here are some automated review suggestions for this pull request.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Comment thread README.md
Comment on lines +84 to +88
# Install uv (one time)
pip install uv

# Install dependencies
pip install -r requirements.txt
# Sync dependencies from lockfile (creates .venv)
uv sync --frozen --no-install-project
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge Restore environment activation in README setup

The Quick Start now tells users to pip install uv and run uv sync --frozen --no-install-project but never tells them to activate .venv or to run commands via uv run. On a clean machine this leaves the global interpreter in use, so the next Python commands in the guide (e.g., running scripts/setup_config.sh followed by python ... later in the README) will execute without the dependencies that were just installed into .venv, resulting in ModuleNotFoundError for packages like pydantic or httpx. The instructions need to include activating .venv or consistently using uv run so that following the README actually yields a working environment.

Useful? React with 👍 / 👎.

Comment thread AGENTS.md
Comment on lines 43 to +49
### Installation
```bash
# 1. Install Python dependencies
pip install -r requirements.txt
# 1. Install uv (one time)
pip install uv

# 2. Sync dependencies from lockfile (creates .venv)
uv sync --frozen --no-install-project
Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

P1 Badge AGENTS.md setup skips enabling the uv virtualenv

The updated installation steps install uv and run uv sync --frozen --no-install-project but never switch the shell to use the created .venv nor suggest running subsequent Python commands via uv run. Anyone following AGENTS.md on a fresh system will keep using the system interpreter, so later commands like the configuration sanity check python -c "from src.config.settings import get_settings; ..." will fail because the dependencies were installed only into .venv. The setup section should explicitly activate .venv (or wrap commands with uv run) so that the documented workflow actually works.

Useful? React with 👍 / 👎.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant