Skip to content

Commit 0e24aeb

Browse files
author
Lukas Geiger
committed
docs: refresh MethodenAnalyser repo hygiene
1 parent 6f6e8fa commit 0e24aeb

11 files changed

Lines changed: 245 additions & 120 deletions

File tree

.github/workflows/tests.yml

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: MethodenAnalyser smoke tests
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
workflow_dispatch:
9+
10+
permissions:
11+
contents: read
12+
13+
jobs:
14+
smoke:
15+
runs-on: windows-latest
16+
strategy:
17+
fail-fast: false
18+
matrix:
19+
python-version: ["3.10", "3.11", "3.12"]
20+
21+
steps:
22+
- uses: actions/checkout@v6
23+
- uses: actions/setup-python@v6
24+
with:
25+
python-version: ${{ matrix.python-version }}
26+
27+
- name: Compile Python files
28+
run: python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py
29+
30+
- name: Import analyzer module
31+
run: python -c "import MethodenAnalyser3 as m; print(m.SIMILARITY_THRESHOLD)"

.gitignore

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66

77
# ---- Python ----
88
__pycache__/
9+
.pytest_cache/
910
*.py[cod]
1011
*$py.class
1112
*.egg-info/
@@ -27,6 +28,8 @@ TESTS.txt
2728
TESTERGEBNISSE.txt
2829
BUGREPORT.md
2930
DIAGNOSE_REPORT.md
31+
SKILL.md
32+
tmpclaude-*
3033

3134
# ---- Persoenliche / Sensible Daten ----
3235
_USER/
@@ -37,6 +40,9 @@ client_secret*.json
3740
token.json
3841
*.pem
3942
*.key
43+
*.db
44+
*.sqlite
45+
*.sqlite3
4046
keyring/
4147

4248
# ---- Build-Artefakte & Releases ----
@@ -66,5 +72,7 @@ PLAN.txt
6672
_archive/
6773
_private/
6874
*.log
75+
*.tmp
76+
*.bak
6977

7078
# ---- Projektspezifisch (hier eigene Eintraege anfuegen) ----

CHANGELOG.md

Lines changed: 15 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,20 +1,26 @@
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-
-
8+
### Hinzugefügt / Added
9+
- README bindet jetzt den vorhandenen GUI-Screenshot aus `README/screenshots/main.png` direkt ein.
10+
- Das Hauptfenster verwendet das lokale `MethodenAnalyser.ico`, wenn es verfügbar ist.
11+
- GitHub Actions Smoke-Test kompiliert die Python-Dateien auf Python 3.10 bis 3.12.
12+
- `RELEASES.md` dokumentiert die lokale Release-Struktur ohne Build-Artefakte ins Repository aufzunehmen.
1013

11-
### Geaendert / Changed
12-
-
14+
### Geändert / Changed
15+
- README, SECURITY und CONTRIBUTING verweisen auf `dev-bricks/MethodenAnalyser`.
16+
- `START.bat` setzt UTF-8/PYTHONIOENCODING und nutzt `py -3` mit `python`-Fallback.
17+
- Lokale Release-Artefakte bleiben unter dem ignorierten `releases/`-Ordner oder in GitHub Releases.
1318

1419
### Behoben / Fixed
15-
-
20+
- Öffentliche persönliche Kontakt-Mail aus `CODE_OF_CONDUCT.md` entfernt.
21+
- Haftungshinweis ist jetzt auf die tatsächliche MIT-Lizenz beschränkt.
1622

1723
## [1.0.0] - YYYY-MM-DD
1824

19-
### Hinzugefuegt / Added
20-
- Erstveroeffentlichung / Initial release
25+
### Hinzugefügt / Added
26+
- Erstveröffentlichung / Initial release.

CODE_OF_CONDUCT.md

Lines changed: 20 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -4,60 +4,59 @@
44

55
### Unser Versprechen
66

7-
Wir als Mitglieder, Beitragende und Leitende verpflichten uns, die Teilnahme an unserer
8-
Community zu einer belaetigungsfreien Erfahrung fuer alle zu machen, unabhaengig von
9-
Alter, Koerpergroesse, sichtbarer oder unsichtbarer Behinderung, ethnischer Zugehoerigkeit,
10-
Geschlechtsmerkmalen, Geschlechtsidentitaet und -ausdruck, Erfahrungsgrad, Bildung,
11-
sozio-oekonomischem Status, Nationalitaet, persoenlichem Aussehen, Herkunft, Religion
12-
oder sexueller Identitaet und Orientierung.
7+
Wir als Mitglieder, Beitragende und Leitende verpflichten uns, die Teilnahme an unserer Community zu einer belästigungsfreien Erfahrung für alle zu machen, unabhängig von Alter, Körpergröße, sichtbarer oder unsichtbarer Behinderung, ethnischer Zugehörigkeit, Geschlechtsmerkmalen, Geschlechtsidentität und -ausdruck, Erfahrungsgrad, Bildung, sozioökonomischem Status, Nationalität, persönlichem Aussehen, Herkunft, Religion oder sexueller Identität und Orientierung.
138

149
### Unsere Standards
1510

16-
Beispiele fuer Verhalten, das zu einem positiven Umfeld beitraegt:
11+
Beispiele für Verhalten, das zu einem positiven Umfeld beiträgt:
12+
1713
- Verwendung einladender und inklusiver Sprache
1814
- Respektvoller Umgang mit unterschiedlichen Standpunkten und Erfahrungen
19-
- Konstruktive Kritik hoeflich annehmen
20-
- Fokus auf das Beste fuer die Community
15+
- Konstruktive Kritik höflich annehmen
16+
- Fokus auf das Beste für die Community
2117

2218
Inakzeptables Verhalten umfasst:
23-
- Trolling, beleidigende Kommentare und persoenliche oder politische Angriffe
24-
- Oeffentliche oder private Belaestigung
25-
- Veroeffentlichung privater Informationen anderer ohne ausdrueckliche Erlaubnis
19+
20+
- Trolling, beleidigende Kommentare und persönliche oder politische Angriffe
21+
- Öffentliche oder private Belästigung
22+
- Veröffentlichung privater Informationen anderer ohne ausdrückliche Erlaubnis
2623

2724
### Durchsetzung
2825

29-
Faelle von missbräuchlichem Verhalten koennen dem Projektteam unter
30-
**lukas@geiger.sh** gemeldet werden. Alle Beschwerden werden geprueft und untersucht.
26+
Fälle von missbräuchlichem Verhalten können über GitHub an das Projektteam gemeldet werden:
27+
https://github.com/dev-bricks/MethodenAnalyser/issues/new
28+
29+
Bitte veröffentlichen Sie keine privaten Daten in öffentlichen Issues. Vertrauliche Sicherheitsaspekte gehören in GitHub Private Vulnerability Reporting.
3130

3231
---
3332

3433
## English
3534

3635
### Our Pledge
3736

38-
We as members, contributors, and leaders pledge to make participation in our
39-
community a harassment-free experience for everyone, regardless of age, body size,
40-
visible or invisible disability, ethnicity, sex characteristics, gender identity
41-
and expression, level of experience, education, socio-economic status, nationality,
42-
personal appearance, race, religion, or sexual identity and orientation.
37+
We as members, contributors, and leaders pledge to make participation in our community a harassment-free experience for everyone, regardless of age, body size, visible or invisible disability, ethnicity, sex characteristics, gender identity and expression, level of experience, education, socio-economic status, nationality, personal appearance, race, religion, or sexual identity and orientation.
4338

4439
### Our Standards
4540

4641
Examples of behavior that contributes to a positive environment:
42+
4743
- Using welcoming and inclusive language
4844
- Being respectful of differing viewpoints and experiences
4945
- Gracefully accepting constructive criticism
5046
- Focusing on what is best for the community
5147

5248
Unacceptable behavior includes:
49+
5350
- Trolling, insulting comments, and personal or political attacks
5451
- Public or private harassment
5552
- Publishing others' private information without explicit permission
5653

5754
### Enforcement
5855

59-
Instances of abusive behavior may be reported to the project team at
60-
**lukas@geiger.sh**. All complaints will be reviewed and investigated.
56+
Instances of abusive behavior may be reported to the project team through GitHub:
57+
https://github.com/dev-bricks/MethodenAnalyser/issues/new
58+
59+
Please do not publish private data in public issues. Confidential security concerns belong in GitHub Private Vulnerability Reporting.
6160

6261
---
6362

CONTRIBUTING.md

Lines changed: 33 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -2,70 +2,70 @@
22

33
## Deutsch
44

5-
Vielen Dank fuer Ihr Interesse, zu diesem Projekt beizutragen!
5+
Vielen Dank für Ihr Interesse, zu diesem Projekt beizutragen.
66

7-
### Wie Sie beitragen koennen
7+
### Wie Sie beitragen können
88

9-
1. **Bug melden:** Erstellen Sie ein Issue mit dem Label `bug`
10-
2. **Feature vorschlagen:** Erstellen Sie ein Issue mit dem Label `enhancement`
11-
3. **Code beitragen:** Erstellen Sie einen Pull Request
9+
1. **Bug melden:** Erstellen Sie ein Issue mit dem Label `bug`.
10+
2. **Feature vorschlagen:** Erstellen Sie ein Issue mit dem Label `enhancement`.
11+
3. **Code beitragen:** Erstellen Sie einen Pull Request.
1212

1313
### Pull Requests
1414

15-
1. Forken Sie das Repository
16-
2. Erstellen Sie einen Feature-Branch: `git checkout -b feature/mein-feature`
17-
3. Committen Sie Ihre Aenderungen: `git commit -m "Beschreibung der Aenderung"`
18-
4. Pushen Sie den Branch: `git push origin feature/mein-feature`
19-
5. Erstellen Sie einen Pull Request
15+
1. Forken Sie das Repository.
16+
2. Erstellen Sie einen Feature-Branch: `git checkout -b feature/mein-feature`.
17+
3. Committen Sie Ihre Änderungen: `git commit -m "Beschreibung der Änderung"`.
18+
4. Pushen Sie den Branch: `git push origin feature/mein-feature`.
19+
5. Erstellen Sie einen Pull Request.
2020

2121
### Code-Richtlinien
2222

23-
- Python: PEP 8 Stil
24-
- Encoding: UTF-8 fuer alle Dateien
25-
- Sprache: Code und Kommentare auf Deutsch oder Englisch
26-
- Keine hardcoded Pfade oder API-Keys
23+
- Python: PEP 8 Stil.
24+
- Encoding: UTF-8 für alle Dateien.
25+
- Sprache: Code und Kommentare auf Deutsch oder Englisch.
26+
- Keine hardcoded Pfade, API-Keys, Tokens oder privaten Daten.
27+
- Vor Pull Requests mindestens `python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py` ausführen.
2728

2829
### Erste Schritte
2930

3031
```bash
31-
git clone https://github.com/lukisch/MethodenAnalyser.git
32+
git clone https://github.com/dev-bricks/MethodenAnalyser.git
3233
cd MethodenAnalyser
33-
pip install -r requirements.txt
34-
python main.py
34+
python MethodenAnalyser3.py
3535
```
3636

3737
---
3838

3939
## English
4040

41-
Thank you for your interest in contributing to this project!
41+
Thank you for your interest in contributing to this project.
4242

4343
### How to Contribute
4444

45-
1. **Report bugs:** Create an issue with the `bug` label
46-
2. **Suggest features:** Create an issue with the `enhancement` label
47-
3. **Contribute code:** Create a Pull Request
45+
1. **Report bugs:** Create an issue with the `bug` label.
46+
2. **Suggest features:** Create an issue with the `enhancement` label.
47+
3. **Contribute code:** Create a pull request.
4848

4949
### Pull Requests
5050

51-
1. Fork the repository
52-
2. Create a feature branch: `git checkout -b feature/my-feature`
53-
3. Commit your changes: `git commit -m "Description of change"`
54-
4. Push the branch: `git push origin feature/my-feature`
55-
5. Create a Pull Request
51+
1. Fork the repository.
52+
2. Create a feature branch: `git checkout -b feature/my-feature`.
53+
3. Commit your changes: `git commit -m "Description of change"`.
54+
4. Push the branch: `git push origin feature/my-feature`.
55+
5. Create a pull request.
5656

5757
### Code Guidelines
5858

59-
- Python: PEP 8 style
60-
- Encoding: UTF-8 for all files
61-
- Language: Code and comments in German or English
62-
- No hardcoded paths or API keys
59+
- Python: PEP 8 style.
60+
- Encoding: UTF-8 for all files.
61+
- Language: Code and comments in German or English.
62+
- No hardcoded paths, API keys, tokens, or private data.
63+
- Before opening a pull request, run `python -m py_compile MethodenAnalyser3.py manage_translations.py translator.py`.
6364

6465
### Getting Started
6566

6667
```bash
67-
git clone https://github.com/lukisch/MethodenAnalyser.git
68+
git clone https://github.com/dev-bricks/MethodenAnalyser.git
6869
cd MethodenAnalyser
69-
pip install -r requirements.txt
70-
python main.py
70+
python MethodenAnalyser3.py
7171
```

MethodenAnalyser.ico

119 KB
Binary file not shown.

MethodenAnalyser3.py

Lines changed: 7 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,6 +30,7 @@
3030
OUTPUT_WIDTH = 140
3131
OUTPUT_HEIGHT = 40
3232
OUTPUT_FONT = ("Courier", 9)
33+
APP_ICON_PATH = os.path.join(os.path.dirname(os.path.abspath(__file__)), "MethodenAnalyser.ico")
3334

3435
# Analyse Konfiguration
3536
SIMILARITY_THRESHOLD = 0.8
@@ -1275,6 +1276,11 @@ def create_gui() -> None:
12751276
root = tk.Tk()
12761277
root.title("Python Code Analyzer v3.0 - Multi-File")
12771278
root.geometry(WINDOW_GEOMETRY)
1279+
if os.path.exists(APP_ICON_PATH):
1280+
try:
1281+
root.iconbitmap(default=APP_ICON_PATH)
1282+
except tk.TclError:
1283+
pass
12781284

12791285
# Button-Frame für besseres Layout
12801286
button_frame = tk.Frame(root)
@@ -1380,4 +1386,4 @@ def create_gui() -> None:
13801386
# ============================================================================
13811387

13821388
if __name__ == "__main__":
1383-
create_gui()
1389+
create_gui()

0 commit comments

Comments
 (0)