Skip to content

Commit 6c271ea

Browse files
author
Lukas Geiger
committed
docs: improve DevCenter discoverability
1 parent 7d65eb5 commit 6c271ea

5 files changed

Lines changed: 100 additions & 22 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: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,18 +14,18 @@ jobs:
1414
welcome:
1515
runs-on: ubuntu-latest
1616
steps:
17-
- uses: actions/first-interaction@v1
17+
- uses: actions/first-interaction@v3
1818
with:
19-
repo-token: ${{ secrets.GITHUB_TOKEN }}
20-
issue-message: |
19+
repo_token: ${{ secrets.GITHUB_TOKEN }}
20+
issue_message: |
2121
Welcome! 👋 Thanks for opening your first issue in this repository.
2222
2323
We'll review it as soon as possible. In the meantime:
2424
- Check if there's a similar issue already open
2525
- Add as much detail as possible (steps to reproduce, expected behavior, environment)
2626
2727
If you'd like to contribute a fix, PRs are always welcome!
28-
pr-message: |
28+
pr_message: |
2929
Welcome! 👋 Thanks for your first pull request in this repository.
3030
3131
A maintainer will review it soon. Please make sure:

CHANGELOG.md

Lines changed: 15 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,28 @@
1-
# Changelog / Aenderungsprotokoll
1+
# Changelog / Änderungsprotokoll
22

3-
Alle wesentlichen Aenderungen an diesem Projekt werden hier dokumentiert.
3+
Alle wesentlichen Änderungen an diesem Projekt werden hier dokumentiert.
44
Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
55

66
## [Unreleased]
77

8-
### Hinzugefuegt / Added
9-
- GitHub Actions Smoke-Checks fuer Python 3.10, 3.11 und 3.12.
10-
- Lokales `build_exe.bat` fuer den PyInstaller-Build mit `DevCenter.ico`.
11-
- Datenschutzhinweise fuer lokale Einstellungen, Datei-Indizes, Build-Artefakte und optionale API-Nutzung.
8+
### Hinzugefügt / Added
9+
- GitHub Actions Smoke-Checks für Python 3.10, 3.11 und 3.12.
10+
- Lokales `build_exe.bat` für den PyInstaller-Build mit `DevCenter.ico`.
11+
- Datenschutzhinweise für lokale Einstellungen, Datei-Indizes, Build-Artefakte und optionale API-Nutzung.
12+
- `llms.txt` mit maschinenlesbarer Projektpositionierung, Datenschutzgrenzen und relevanten Suchbegriffen.
1213

13-
### Geaendert / Changed
14+
### Geändert / Changed
1415
- README, Contribution- und Security-Dokumentation auf `dev-bricks/DevCenter` aktualisiert.
15-
- Beispielkonfiguration fuer WinStorePackager anonymisiert und neutralisiert.
16+
- Beispielkonfiguration für WinStorePackager anonymisiert und neutralisiert.
17+
- README auf englischen GitHub-Einstieg, klarere DevCenter-Namensabgrenzung und bessere Discoverability-Keywords erweitert.
18+
- Community-Workflows auf aktuelle Action-Versionen gehoben.
1619

1720
### Behoben / Fixed
18-
- Persistenz unbekannter Einstellungsschluessel abgesichert, damit UI-/Legacy-Aliase beim Speichern nicht verloren gehen.
19-
- Fehlende `chardet`-Abhaengigkeit fuer frische CI-/Installationsumgebungen ergaenzt.
21+
- Persistenz unbekannter Einstellungsschlüssel abgesichert, damit UI-/Legacy-Aliase beim Speichern nicht verloren gehen.
22+
- Fehlende `chardet`-Abhängigkeit für frische CI-/Installationsumgebungen ergänzt.
2023
- Editor-Einstellungen werden nach dem Speichern auf offene Tabs angewendet; der Dialog persistiert jetzt auch „Aktuelle Zeile hervorheben“ und aktualisiert Schrift, Tab-Breite, Zeilennummern und Cursor-Markierung unmittelbar.
2124

2225
## [1.0.0] - YYYY-MM-DD
2326

24-
### Hinzugefuegt / Added
25-
- Erstveroeffentlichung / Initial release
27+
### Hinzugefügt / Added
28+
- Erstveröffentlichung / Initial release

README.md

Lines changed: 46 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,61 @@
11
# 🚀 DevCenter
22

3-
**Python Development Suite** - Eine integrierte Entwicklungsumgebung für den kompletten Python-Entwicklungszyklus
3+
**Local-first Python IDE and developer toolkit for Windows.** DevCenter combines a PySide6 code editor, static analyzer, PyInstaller build helper, license collector, file index and optional Claude/Anthropic assistant in one desktop suite.
44

55
![Version](https://img.shields.io/badge/version-1.0.0-blue)
66
![Python](https://img.shields.io/badge/python-3.10+-green)
77
![License](https://img.shields.io/badge/license-GPL%20v3-blue)
88

9-
## 📋 Übersicht
9+
## Overview
10+
11+
DevCenter is a local desktop development suite for Python projects that covers the practical workflow from first file to release checklist:
12+
13+
**Write -> Analyze -> Test -> Build -> Publish**
14+
15+
It is designed for developers who want a lightweight local IDE with built-in project analysis, EXE packaging support, privacy-aware settings, and export planning for a future read-only Web/PWA companion.
16+
17+
This repository is **not** Azure DevCenter, Microsoft Dev Box, Moderne DevCenter or Devbox. It is the `dev-bricks/DevCenter` open-source Python desktop app.
18+
19+
![DevCenter main window showing the local Python IDE dashboard](README/screenshots/main.png)
20+
21+
## Why DevCenter
22+
23+
- **Local-first workflow:** projects, indexes, settings and build artifacts stay on your machine by default.
24+
- **Python desktop focus:** PySide6 interface, syntax highlighting, project explorer, terminal output and settings persistence.
25+
- **Static analysis built in:** method/class detection, complexity checks, import analysis, TODO/FIXME detection and encoding repair helpers.
26+
- **Build and release helpers:** PyInstaller wrapper, icon conversion, third-party license collection, release notes and export planning.
27+
- **Optional AI assistant:** Claude/Anthropic integration is opt-in and should use local settings, keyring or environment variables.
28+
- **Companion-ready export plan:** `devcenter-workspace-v1.json` is planned for redacted project-status handoff to a static Web/PWA viewer.
29+
30+
## Quick Start
31+
32+
```bash
33+
git clone https://github.com/dev-bricks/DevCenter.git
34+
cd DevCenter
35+
pip install -r requirements.txt
36+
python main.py
37+
```
38+
39+
Windows helpers:
40+
41+
```batch
42+
START_DevCenter.bat
43+
build_exe.bat
44+
```
45+
46+
## Keywords
47+
48+
`Python IDE`, `PySide6 IDE`, `local-first developer tools`, `offline Python editor`, `PyInstaller GUI`, `static code analyzer`, `developer toolkit`, `Windows Python desktop app`, `AI-assisted coding`, `license collector`, `project export`, `PWA companion`.
49+
50+
## Deutsch: Übersicht
1051

1152
DevCenter ist eine All-in-One Desktop-IDE für Python-Projekte, die den kompletten Entwicklungszyklus unterstützt:
1253

13-
**Code schreiben Analysieren Testen Kompilieren Veröffentlichen**
54+
**Code schreiben -> Analysieren -> Testen -> Kompilieren -> Veröffentlichen**
1455

15-
## Screenshot
56+
DevCenter ist eine lokale Desktop-Anwendung und nicht mit Azure DevCenter, Microsoft Dev Box, Moderne DevCenter oder Devbox identisch.
1657

17-
![DevCenter Hauptfenster](README/screenshots/main.png)
58+
![DevCenter Hauptfenster mit lokalem Python-IDE-Dashboard](README/screenshots/main.png)
1859

1960
### 🔧 Fusionierte Tools
2061

llms.txt

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
# DevCenter
2+
3+
Canonical repository: https://github.com/dev-bricks/DevCenter
4+
5+
DevCenter is a local-first Python desktop IDE and developer toolkit from dev-bricks. It combines a PySide6 editor, static analysis, encoding repair, PyInstaller build helpers, icon conversion, third-party license collection, project/file indexing, backup-oriented sync helpers and an optional Claude/Anthropic AI assistant.
6+
7+
Primary audience:
8+
- Python developers who want a lightweight Windows-first desktop IDE.
9+
- Maintainers who need local analysis, build and release helpers in one app.
10+
- LLM agents that need project metadata and redacted status exports without uploading full source trees.
11+
12+
Positioning:
13+
- This is not Azure DevCenter, Microsoft Dev Box, Moderne DevCenter or Devbox.
14+
- This is not a hosted cloud IDE.
15+
- The desktop app is authoritative; the Web/PWA companion is planned as a read-only viewer for redacted `devcenter-workspace-v1.json` exports.
16+
17+
Privacy and safety:
18+
- Projects, settings, file indexes and build artifacts stay local by default.
19+
- Network access is only expected for explicitly configured integrations such as the optional Claude/Anthropic API or package installation commands started by the user.
20+
- API keys, tokens, local absolute paths and full source contents must not be written into public exports.
21+
22+
Important files:
23+
- `README.md`: user-facing overview, screenshots, installation and feature list.
24+
- `PRIVACY_POLICY.md`: privacy scope for local settings, indexes, build artifacts and optional API use.
25+
- `EXPORTFORMAT.md`: planned redacted workspace export contract.
26+
- `PORTIERUNGSPLAN.md`: desktop, Web/PWA, Linux, macOS and Store strategy.
27+
- `.github/workflows/tests.yml`: Windows smoke tests for Python 3.10, 3.11 and 3.12.
28+
29+
Useful search phrases:
30+
- local-first Python IDE
31+
- PySide6 Python development suite
32+
- Windows Python IDE with PyInstaller build helper
33+
- offline Python code editor and static analyzer
34+
- Python developer toolkit with license collector

0 commit comments

Comments
 (0)