Skip to content

Commit 5bb61e3

Browse files
author
Lukas Geiger
committed
docs: add MethodenAnalyser llms metadata
1 parent 7cb496a commit 5bb61e3

5 files changed

Lines changed: 50 additions & 5 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: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,10 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
55

66
## [Unreleased]
77

8+
### Repository-Hygiene
9+
- `llms.txt` ergänzt mit kanonischen Links, Tool-Scope, lokalen Interfaces und Datenschutzgrenzen für Crawler, LLMs und Verzeichnisdienste.
10+
- Community-Workflows aktualisiert: `actions/stale@v10` und `actions/first-interaction@v3` mit aktuellen Input-Namen.
11+
812
### Portierung / Platforms
913
- `PORTIERUNGSPLAN.md` ist nach User-Korrektur auf Desktop-only geschärft: Windows Store bleibt Hauptkanal, macOS/Linux bleiben Source-Smoke-Ziele, Web/PWA/Android/iOS sind keine Produktlinien.
1014
- Die vorhandene lokale Weboberfläche wird nur noch als Hilfs-/Demo-Modus innerhalb des Desktop-Projekts geführt, nicht als Companion-App.

README.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -190,6 +190,8 @@ python -m unittest discover -s tests -v
190190

191191
GitHub Actions führt denselben Smoke-Test jetzt auf Windows (Python 3.10 bis 3.12) sowie zusätzlich auf Ubuntu und macOS (Python 3.11) aus.
192192

193+
Für Crawler, LLMs und Verzeichnisdienste liegt ein knapper maschinenlesbarer Projektkontext in [llms.txt](llms.txt). Die Community-Workflows verwenden aktuelle `actions/stale`- und `actions/first-interaction`-Versionen.
194+
193195
---
194196

195197
## Lizenz

llms.txt

Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
# MethodenAnalyser
2+
3+
> Static Python code analyzer with a local Tkinter GUI, CLI mode, JSON reports and an optional local browser helper.
4+
5+
## Canonical Links
6+
7+
- Repository: https://github.com/dev-bricks/MethodenAnalyser
8+
- Documentation: https://github.com/dev-bricks/MethodenAnalyser#readme
9+
- Issues: https://github.com/dev-bricks/MethodenAnalyser/issues
10+
- License: MIT
11+
12+
## What It Does
13+
14+
MethodenAnalyser analyzes Python files and project folders locally with Python AST logic. It finds unused imports, unused definitions, missing definitions/imports, duplicate imports and similar code blocks. The app is Windows-first, has no external runtime dependencies and can also run from source on macOS and Linux.
15+
16+
## Interfaces
17+
18+
- Desktop GUI: `python MethodenAnalyser3.py` or `START.bat` on Windows.
19+
- CLI file analysis: `python MethodenAnalyser3.py --file path/to/file.py`.
20+
- CLI project analysis: `python MethodenAnalyser3.py --project path/to/project`.
21+
- JSON export: add `--json-output` or pass a target JSON filename.
22+
- Local web helper: `python webapp/server.py` or `START_WEBAPP.bat`.
23+
24+
## Data And Privacy
25+
26+
All analysis runs locally. The tool does not include telemetry, cloud sync, external APIs or CDN dependencies. Source code and reports stay on the user's machine unless the user explicitly shares them.
27+
28+
## Scope
29+
30+
- Good fit: local Python project review, refactoring preparation, code cleanup, LLM/CI automation gates and Microsoft Store desktop packaging.
31+
- Not a goal: cloud analysis service, native Android/iOS app, remote code upload or full browser replacement for local project-folder analysis.
32+
33+
## Main Files
34+
35+
- `README.md`: user-facing overview and quickstart.
36+
- `EXPORTFORMAT.md`: `methodenanalyser-report-v1.json` schema.
37+
- `WEBAPP.md`: local browser helper details.
38+
- `PORTIERUNGSPLAN.md`: platform scope and non-goals.
39+
- `.github/workflows/tests.yml`: Windows, Ubuntu and macOS smoke matrix.

0 commit comments

Comments
 (0)