Skip to content

Commit 4f2b420

Browse files
author
Lukas Geiger
committed
docs: add PythonBox llms discovery context
1 parent 225344d commit 4f2b420

5 files changed

Lines changed: 53 additions & 2 deletions

File tree

.github/workflows/stale.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ jobs:
1313
stale:
1414
runs-on: ubuntu-latest
1515
steps:
16-
- uses: actions/stale@v9
16+
- uses: actions/stale@v10
1717
with:
1818
stale-issue-message: >
1919
This issue has been automatically marked as stale because it has not had

.github/workflows/welcome.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ jobs:
1414
welcome:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/first-interaction@v1
17+
- uses: actions/first-interaction@v3
1818
with:
1919
repo-token: ${{ secrets.GITHUB_TOKEN }}
2020
issue-message: |

CHANGELOG.md

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

88
### Hinzugefügt / Added
9+
- `llms.txt` mit kanonischem Repo-Kontext, Zielgruppe, Suchphrasen und Abgrenzung zu Devbox/Python-Box/Pybricks.
10+
- README-Starttabelle und GitHub-Actions-Badge für schnellere Nutzerführung.
911
- App- und Fenstericon über `PythonBox.ico`.
1012
- `build_exe.bat` für lokale PyInstaller-Builds.
1113
- `PORTIERUNGSPLAN.md` mit Desktop-only-Strategie für Windows, macOS und Linux.
@@ -14,6 +16,7 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
1416
- README-SEO-Einstieg, präzisere Screenshot-Beschreibung und Discovery-Keywords für die GitHub-Suche.
1517

1618
### Geändert / Changed
19+
- Community-Workflows auf `actions/stale@v10` und `actions/first-interaction@v3` aktualisiert.
1720
- README, Security Policy, Contributing Guide und Code of Conduct auf das aktuelle Repository `dev-bricks/pythonbox` und die MIT-Lizenz ausgerichtet.
1821
- `.gitignore` um interne Steuerungsdateien, Secrets, Datenbanken, Logs, Test-Locks und Windows-/Build-Artefakte erweitert.
1922
- Dokumentierte Mindestversion auf Python 3.10+ vereinheitlicht, passend zur Startdatei und Testmatrix.

README.md

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,19 @@ PythonBox ist eine lokale Python-IDE für Windows-Entwicklerinnen und -Entwickle
66

77
![Python](https://img.shields.io/badge/Python-3.10+-blue.svg)
88
![PySide6](https://img.shields.io/badge/PySide6-6.5+-green.svg)
9+
![PythonBox tests](https://github.com/dev-bricks/pythonbox/actions/workflows/tests.yml/badge.svg)
910
![License](https://img.shields.io/badge/License-MIT-yellow.svg)
1011

12+
## Start here
13+
14+
| If you want to... | Start with |
15+
|---|---|
16+
| Try the IDE from source | `python PythonBox_v8.py` |
17+
| Build a local Windows EXE | `build_exe.bat` |
18+
| Check the regression suite | `python -m unittest discover -s tests -v` |
19+
| Understand the platform boundary | [PORTIERUNGSPLAN.md](PORTIERUNGSPLAN.md) |
20+
| Give an LLM or crawler the repo context | [llms.txt](llms.txt) |
21+
1122
## Why PythonBox?
1223

1324
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.

llms.txt

Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
# PythonBox
2+
3+
Canonical repository: https://github.com/dev-bricks/pythonbox
4+
Primary README: https://github.com/dev-bricks/pythonbox#readme
5+
Owner organization: dev-bricks
6+
Default branch: master
7+
License: MIT
8+
9+
## Summary
10+
11+
PythonBox is a lightweight local-first Python IDE for Windows. It combines a PySide6 editor, PDB debugging, code folding, linting hooks, Git status/diff visibility, and optional handoff to VS Code or PyCharm.
12+
13+
## Audience
14+
15+
- Windows users who want a focused Python editor without a full IDE setup.
16+
- Learners and automation builders who need run/debug/lint/Git feedback in one local desktop app.
17+
- LLM-assisted coding workflows where files remain local and users want a small GUI around scripts.
18+
19+
## What this repository contains
20+
21+
- `PythonBox_v8.py`: main PySide6 application.
22+
- `README.md`: user-facing overview, installation, features, privacy boundary, and discovery keywords.
23+
- `PORTIERUNGSPLAN.md`: platform strategy for Windows-first desktop use and source-smoke portability.
24+
- `tests/`: regression tests for Qt6 compatibility, execution routing, Git diff/status handling, minimap settings, and an offscreen window smoke test.
25+
- `.github/workflows/tests.yml`: Windows regression test workflow for Python 3.10, 3.11, and 3.12.
26+
27+
## Search phrases
28+
29+
python ide; lightweight python editor; pyside6 code editor; windows python ide; local-first developer tool; pdb debugger gui; python linting; code folding; git diff editor; offline python editor; VS Code handoff; PyCharm handoff.
30+
31+
## Disambiguation
32+
33+
PythonBox is not Jetify Devbox, Microsoft Dev Box, Box Python SDK, Pybricks, or a containerized development environment. It is a local desktop Python editor and debugger.
34+
35+
## Safety and privacy boundary
36+
37+
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.

0 commit comments

Comments
 (0)