Skip to content

Commit ab2a132

Browse files
committed
docs(marketing): add LLM-Ready/Ecosystem badges, GFM callouts, Mermaid architecture & update llms.txt date
1 parent d255b7e commit ab2a132

4 files changed

Lines changed: 73 additions & 1 deletion

File tree

CHANGELOG.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,10 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
66
## [Unreleased]
77

88
### Geändert / Changed
9+
- Discoverability & Marketing Audit (2026-07-26): `README.md` & `README_de.md` mit LLM-Ready-, Ecosystem- und Umbrella-Badges, GFM-Hinweisboxen (`> [!NOTE]` / `> [!TIP]`) und Mermaid-Systemarchitekturdiagramm erweitert; `llms.txt` Header auf `Last-checked: 2026-07-26` aktualisiert (92/92 Pytest-Tests 100% grün).
910
- Dokumentations- & Sichtbarkeitspflege (2026-07-24): `llms.txt` auf `Last-checked: 2026-07-24` mit aktualisierter Testsuite-Beschreibung (92 Pytest-Tests) aktualisiert, dedizierte deutsche Startseite (`README_de.md`) angelegt, zweisprachige Sprachwahl-Navigation (`[English](README.md) | [Deutsch](README_de.md)`) oben in den READMEs integriert und Test-Badge ergänzt.
1011

12+
1113
### Build / Release
1214
- EXE neu gebaut 2026-06-04 (PyInstaller, OneDrive-externer Build); `START_PythonBox_v8.bat` startet jetzt bevorzugt `dist\PythonBox.exe` und fällt danach auf Root-EXE bzw. Python-Fallback zurück. SHA256: `1F5C024682B5B77BD04963E972F3EDAB9D9E606DE1339D390D2181A8606672BC`.
1315
- EXE neu gebaut 2026-06-01 (PyInstaller `--onefile`, `PythonBox.exe`); 14/14 Tests grün, Smoke-Test bestanden. Vorherige EXE: 2026-04-29.

README.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,19 @@
1010
[![PySide6](https://img.shields.io/badge/PySide6-6.5+-green.svg)](https://pypi.org/project/PySide6/)
1111
[![PythonBox tests](https://github.com/dev-bricks/pythonbox/actions/workflows/tests.yml/badge.svg)](https://github.com/dev-bricks/pythonbox/actions/workflows/tests.yml)
1212
[![Tests](https://img.shields.io/badge/Tests-92%20passed-brightgreen.svg)](tests/)
13+
[![LLM-Ready](https://img.shields.io/badge/LLM--Ready-llms.txt-blueviolet.svg)](llms.txt)
14+
[![Ecosystem](https://img.shields.io/badge/Ecosystem-dev--bricks-blue.svg)](https://github.com/dev-bricks)
15+
[![Umbrella](https://img.shields.io/badge/Umbrella-open--bricks-indigo.svg)](https://github.com/open-bricks)
1316
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1417

1518
PythonBox is a local-first Python IDE for Windows developers who want a focused editor with PySide6, PDB debugging, code folding, linting, Git status, and optional handoff to VS Code or PyCharm.
1619

20+
> [!NOTE]
21+
> **Local-First & Zero Telemetry**: PythonBox is engineered to run 100% offline with zero cloud sync, zero telemetry, and local file storage. It is fully indexable and optimized for LLM-assisted workflows via `llms.txt`.
22+
23+
> [!TIP]
24+
> **PDB Debugging & Headless Mode**: Toggle breakpoints directly in the GUI editor or launch PythonBox headlessly in CI/automation pipelines using `--run demo.py` or `--lint demo.py`.
25+
1726
## Start here
1827

1928
| If you want to... | Start with |
@@ -28,8 +37,34 @@ PythonBox is a local-first Python IDE for Windows developers who want a focused
2837

2938
PythonBox is built for small Python scripts, local automation tools, learning workflows, and LLM-assisted coding sessions where a full IDE can feel too heavy. It keeps the core loop in one desktop window: open a file, edit Python, run it with the current interpreter, inspect output, debug with breakpoints, and check Git changes before handing the file to a larger IDE when needed.
3039

40+
## System Architecture
41+
42+
```mermaid
43+
flowchart TD
44+
subgraph GUI ["PythonBox PySide6 Desktop GUI"]
45+
ED["Editor Window (QTextEdit / Minimap)"]
46+
DBG["PDB Debugger Panel"]
47+
OUT["Console & Output Log"]
48+
GIT_PANEL["Git Status & Diff Markers"]
49+
end
50+
51+
subgraph CORE ["Core Engine"]
52+
LINT["Linter Hook (Flake8 / Pylint / AST Fallback)"]
53+
EXEC["Interpreter Runner (sys.executable)"]
54+
HANDOFF["Handoff Bridge (VS Code / PyCharm)"]
55+
end
56+
57+
ED --> EXEC
58+
ED --> LINT
59+
EXEC --> OUT
60+
EXEC --> DBG
61+
ED --> HANDOFF
62+
GIT_PANEL --> ED
63+
```
64+
3165
## Screenshot
3266

67+
3368
![PythonBox dark-theme Python IDE with editor, minimap, output panel, and local debugging controls](README/screenshots/main.png)
3469

3570
## Features

README_de.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -10,10 +10,19 @@
1010
[![PySide6](https://img.shields.io/badge/PySide6-6.5+-green.svg)](https://pypi.org/project/PySide6/)
1111
[![PythonBox tests](https://github.com/dev-bricks/pythonbox/actions/workflows/tests.yml/badge.svg)](https://github.com/dev-bricks/pythonbox/actions/workflows/tests.yml)
1212
[![Tests](https://img.shields.io/badge/Tests-92%20passed-brightgreen.svg)](tests/)
13+
[![LLM-Ready](https://img.shields.io/badge/LLM--Ready-llms.txt-blueviolet.svg)](llms.txt)
14+
[![Ecosystem](https://img.shields.io/badge/Ecosystem-dev--bricks-blue.svg)](https://github.com/dev-bricks)
15+
[![Umbrella](https://img.shields.io/badge/Umbrella-open--bricks-indigo.svg)](https://github.com/open-bricks)
1316
[![License](https://img.shields.io/badge/License-MIT-yellow.svg)](LICENSE)
1417

1518
PythonBox ist eine lokale Python-IDE für Windows-Entwicklerinnen und -Entwickler, die einen fokussierten Editor mit PySide6, PDB-Debugging, Code Folding, Linting, Git-Status und optionaler Übergabe an VS Code oder PyCharm suchen.
1619

20+
> [!NOTE]
21+
> **Local-First & Zero-Telemetry**: PythonBox läuft 100% lokal ohne Cloud-Zwang, ohne Telemetrie und speichert Daten ausschließlich auf dem lokalen Dateisystem. Das Repository ist für KI-Agenten und LLM-Workflows über `llms.txt` optimiert.
22+
23+
> [!TIP]
24+
> **PDB-Debugging & Headless-Modus**: Breakpoints lassen sich direkt im GUI-Editor setzen oder in CI/Automatisierungs-Pipelines headless über `--run demo.py` bzw. `--lint demo.py` ausführen.
25+
1726
## Schnellstart
1827

1928
| Ziel | Startbefehl / Datei |
@@ -28,8 +37,34 @@ PythonBox ist eine lokale Python-IDE für Windows-Entwicklerinnen und -Entwickle
2837

2938
PythonBox wurde für kleine Python-Skripte, lokale Automatisierungstools, Lern-Workflows und KI-unterstützte Coding-Sessions entwickelt, bei denen eine vollständige IDE zu schwerfällig wirkt. Es hält den Kern-Workflow in einem einzigen Desktop-Fenster: Datei öffnen, Python editieren, mit dem aktuellen Interpreter ausführen, Ausgaben prüfen, mit Breakpoints debuggen und Git-Änderungen einsehen, bevor die Datei bei Bedarf an eine größere IDE übergeben wird.
3039

40+
## Systemarchitektur
41+
42+
```mermaid
43+
flowchart TD
44+
subgraph GUI ["PythonBox PySide6 Desktop GUI"]
45+
ED["Editor-Fenster (QTextEdit / Minimap)"]
46+
DBG["PDB-Debugger Panel"]
47+
OUT["Konsole & Output-Log"]
48+
GIT_PANEL["Git-Status & Diff-Markierungen"]
49+
end
50+
51+
subgraph CORE ["Kern-Engine"]
52+
LINT["Linter-Hook (Flake8 / Pylint / AST-Fallback)"]
53+
EXEC["Interpreter-Runner (sys.executable)"]
54+
HANDOFF["Handoff-Brücke (VS Code / PyCharm)"]
55+
end
56+
57+
ED --> EXEC
58+
ED --> LINT
59+
EXEC --> OUT
60+
EXEC --> DBG
61+
ED --> HANDOFF
62+
GIT_PANEL --> ED
63+
```
64+
3165
## Screenshot
3266

67+
3368
![PythonBox dark-theme Python IDE mit Editor, Minimap, Output-Panel und lokalem Debugging](README/screenshots/main.png)
3469

3570
## Funktionen / Features

llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -46,4 +46,4 @@ PythonBox is not Jetify Devbox, Microsoft Dev Box, Box Python SDK, Pybricks, or
4646

4747
PythonBox does not include telemetry, cloud sync, bundled credentials, or built-in external service API calls. It opens, saves, and executes files only through user-triggered local workflows.
4848

49-
## Last-checked: 2026-07-24
49+
## Last-checked: 2026-07-26

0 commit comments

Comments
 (0)