Skip to content

docs: add comments to config.py for better readability #6

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
kunalbhardwaj2006 wants to merge 2 commits into from
Closed

docs: add comments to config.py for better readability #6

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
96cbbd0
Update README.mddocs: fix clone URL, correct docker service name, add…
kunalbhardwaj2006 Mar 3, 2026
0395bd2
docs(generator): add module-level documentation to config.py
kunalbhardwaj2006 Mar 6, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,8 +37,8 @@ The system is split into two autonomous components that communicate via shared f
### Quick Start
1. **Clone the repository**:
```bash
git clone https://github.com/imxade/dont-compete.git
cd dont-compete
git clone https://github.com/AOSSIE-Org/LibrEd.git
cd LibrEd
```

2. **Launch the System**:
Expand All @@ -51,7 +51,7 @@ The system is split into two autonomous components that communicate via shared f

3. **Monitor Pipeline**:
```bash
docker compose logs -f generator
asset-generator
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 6, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🔴 Critical

Fix incomplete shell command.

The monitor pipeline command is incomplete and will result in a "command not found" error. Based on the docker-compose.yml configuration, this should be a docker compose logs command targeting the asset-generator service.

📝 Proposed fix for the complete command 
-    asset-generator
+    docker compose logs -f asset-generator
📝 Committable suggestion

‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

Suggested change
asset-generator
docker compose logs -f asset-generator
🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` at line 54, The README contains an incomplete monitor pipeline
command for the asset-generator service; replace the partial entry with the full
docker compose logs invocation (e.g., use "docker compose logs [options]
asset-generator" or "docker compose logs -f asset-generator") so the command
runs against the asset-generator service as defined in docker-compose.yml;
update the README line that currently just says "asset-generator" to the
complete command string referencing asset-generator.

```

### Configuration
Expand Down Expand Up @@ -91,6 +91,16 @@ docker run --rm --network gatebuster_app_network \
mcr.microsoft.com/playwright:v1.58.0-jammy \
/bin/sh -c "npm install && npx playwright test"
```
On Windows PowerShell, use:

```powershell
docker run --rm --network gatebuster_app_network `
-e BASE_URL=http://frontend:3000 `
-v ${PWD}/frontend:/app `
-w /app `
mcr.microsoft.com/playwright:v1.58.0-jammy `
sh -c "npm install && npx playwright test"
```
Comment on lines +94 to +103
Copy link
Copy Markdown

@coderabbitai coderabbitai bot Mar 6, 2026

Choose a reason for hiding this comment

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

⚠️ Potential issue | 🟡 Minor

Add blank line after code fence for proper Markdown formatting.

The Windows PowerShell instructions are functionally correct and provide valuable cross-platform support. However, there's a minor Markdown formatting issue flagged by the linter.

📐 Proposed fix to add blank line 
 sh -c "npm install && npx playwright test"

Note: Ensure the frontend service is running (docker compose up) before starting Playwright tests.

</details>

<!-- suggestion_start -->

<details>
<summary>📝 Committable suggestion</summary>

> ‼️ **IMPORTANT**
> Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.

```suggestion
On Windows PowerShell, use:
🧰 Tools
🪛 markdownlint-cli2 (0.21.0)

[warning] 103-103: Fenced code blocks should be surrounded by blank lines

(MD031, blanks-around-fences)

🤖 Prompt for AI Agents 
Verify each finding against the current code and only fix it if needed.

In `@README.md` around lines 94 - 103, The Markdown code fence for the Windows
PowerShell example needs a blank line after the closing ``` to satisfy the
linter and ensure proper rendering; edit the README.md block containing the
PowerShell docker run example (the triple-backtick fenced code block) to add an
empty line immediately after the closing fence and then add the provided note
paragraph ("Note: Ensure the frontend service is running (`docker compose up`)
before starting Playwright tests.") so there's a blank line between the fence
and the note.

*Note: Ensure the frontend service is running (`docker compose up`) before starting Playwright tests.*

## License
Expand Down
15 changes: 15 additions & 0 deletions generator/src/config.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,18 @@
"""
config.py

Central configuration file for the LibrEd asset generator.

This module defines environment variables and default configuration
values used across the generator pipeline, including:

- Ollama model configuration
- Local LLM server settings
- Asset directories and processing parameters

The configuration is designed to support the project's
100% local and containerized architecture.
"""
import os

# Environment Configuration
Expand Down
Loading