Skip to content

Commit e6e7ed8

Browse files
author
Lukas Geiger
committed
docs: refresh MetaWiki repo hygiene
1 parent 6e961ff commit e6e7ed8

10 files changed

Lines changed: 148 additions & 23 deletions

File tree

.github/workflows/tests.yml

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
name: MetaWiki smoke tests
2+
3+
on:
4+
push:
5+
branches: [master]
6+
pull_request:
7+
branches: [master]
8+
workflow_dispatch:
9+
10+
jobs:
11+
smoke:
12+
runs-on: ubuntu-latest
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
python-version: ['3.10', '3.11', '3.12']
17+
18+
steps:
19+
- uses: actions/checkout@v6
20+
21+
- uses: actions/setup-python@v6
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
25+
- name: Compile Python sources
26+
run: |
27+
python -m py_compile \
28+
check_duplicates.py \
29+
manage_translations.py \
30+
md_to_json.py \
31+
metawiki_cli.py \
32+
metawiki_pipeline.py \
33+
pipeline.py \
34+
translate.py \
35+
translator.py
36+
37+
- name: Check CLI and data pipeline
38+
env:
39+
PYTHONIOENCODING: utf-8
40+
run: |
41+
python metawiki_cli.py --help
42+
python metawiki_cli.py stats
43+
python metawiki_cli.py check
44+
python metawiki_pipeline.py validate

.gitignore

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,19 @@ __pycache__/
1111
.eggs/
1212
dist/
1313
build/
14+
.pytest_cache/
15+
.ruff_cache/
16+
.mypy_cache/
17+
.coverage
18+
htmlcov/
1419

1520
# ---- Virtuelle Umgebungen ----
1621
venv/
1722
.venv/
1823
env/
1924
.env/
2025

21-
# ---- BACH Interne Steuerungsdateien (NIEMALS in Git!) ----
26+
# ---- Interne Steuerungsdateien (NIEMALS in Git!) ----
2227
AUFGABEN.txt
2328
TEST.txt
2429
TESTS.txt
@@ -33,6 +38,7 @@ _USER/
3338
credentials.json
3439
client_secret*.json
3540
token.json
41+
secrets.*
3642
*.pem
3743
*.key
3844
keyring/
@@ -44,6 +50,7 @@ releases/
4450
*.msix
4551
*.appx
4652
*.spec
53+
*.temp
4754

4855
# ---- IDE & Editoren ----
4956
.claude/
@@ -73,3 +80,5 @@ _private/
7380
output/
7481
backups/
7582
*.bak
83+
*.tmp
84+
*-ASUS-GEI.md

CHANGELOG.md

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

88
### Hinzugefuegt / Added
9-
-
9+
- Lokales MetaWiki-Icon, README-Einstieg fuer CLI-Nutzung und Windows-Startskript.
10+
- GitHub-Actions-Smoke-Test fuer CLI, Pipeline-Validierung und Python-Compile-Checks.
1011

1112
### Geaendert / Changed
12-
-
13+
- Repository-Metadaten auf `file-bricks/MetaWiki` aktualisiert.
14+
- Privacy-/Security-Hinweise ohne persoenliche Kontaktadresse geschaerft.
1315

1416
### Behoben / Fixed
15-
-
17+
- Veraltete Clone- und Security-Links aus der frueheren persoenlichen Ablage ersetzt.
1618

1719
## [1.0.0] - YYYY-MM-DD
1820

CODE_OF_CONDUCT.md

Lines changed: 7 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,10 @@ Inakzeptables Verhalten umfasst:
2626

2727
### Durchsetzung
2828

29-
Faelle von missbräuchlichem Verhalten koennen dem Projektteam unter
30-
**lukas@geiger.sh** gemeldet werden. Alle Beschwerden werden geprueft und untersucht.
29+
Faelle von missbräuchlichem Verhalten koennen ueber die GitHub-Issues des Projekts
30+
gemeldet werden. Wenn die Meldung sensible Details enthaelt, nutzen Sie bitte die
31+
private Sicherheitsmeldung dieses Repositories. Alle Beschwerden werden geprueft und
32+
untersucht.
3133

3234
---
3335

@@ -56,8 +58,9 @@ Unacceptable behavior includes:
5658

5759
### Enforcement
5860

59-
Instances of abusive behavior may be reported to the project team at
60-
**lukas@geiger.sh**. All complaints will be reviewed and investigated.
61+
Instances of abusive behavior may be reported through this repository's GitHub issues.
62+
If the report contains sensitive details, use this repository's private vulnerability
63+
reporting flow instead. All complaints will be reviewed and investigated.
6164

6265
---
6366

CONTRIBUTING.md

Lines changed: 8 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,11 @@ Vielen Dank fuer Ihr Interesse, zu diesem Projekt beizutragen!
2828
### Erste Schritte
2929

3030
```bash
31-
git clone https://github.com/lukisch/MetaWiki.git
31+
git clone https://github.com/file-bricks/MetaWiki.git
3232
cd MetaWiki
33-
pip install -r requirements.txt
34-
python main.py
33+
python -m pip install -r requirements.txt
34+
python metawiki_cli.py stats
35+
python metawiki_pipeline.py validate
3536
```
3637

3738
---
@@ -64,8 +65,9 @@ Thank you for your interest in contributing to this project!
6465
### Getting Started
6566

6667
```bash
67-
git clone https://github.com/lukisch/MetaWiki.git
68+
git clone https://github.com/file-bricks/MetaWiki.git
6869
cd MetaWiki
69-
pip install -r requirements.txt
70-
python main.py
70+
python -m pip install -r requirements.txt
71+
python metawiki_cli.py stats
72+
python metawiki_pipeline.py validate
7173
```

MetaWiki.ico

48.6 KB
Binary file not shown.

README.md

Lines changed: 55 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
<h1 align="center">
1111
<br>
12-
<img src="https://raw.githubusercontent.com/github/explore/main/topics/knowledge/knowledge.png" alt="MetaWiki" width="120">
12+
<img src="assets/metawiki_icon.png" alt="MetaWiki" width="120">
1313
<br>
1414
MetaWiki Framework
1515
<br>
@@ -148,7 +148,7 @@ Alle 630 Stubs sind bereits vollstaendig **zweisprachig (DE + EN)**. Fuer neue S
148148

149149
```bash
150150
# API-Key setzen und optionales Paket installieren
151-
export ANTHROPIC_API_KEY="sk-ant-..."
151+
export ANTHROPIC_API_KEY="<your-anthropic-api-key>"
152152
pip install anthropic
153153

154154
# Alle Stubs uebersetzen (fehlende definition_en)
@@ -173,6 +173,30 @@ print(english)
173173

174174
Ohne gesetzten `ANTHROPIC_API_KEY` oder ohne `pip install anthropic` wird die Uebersetzung lautlos uebersprungen.
175175

176+
## Nutzung / Usage
177+
178+
```bash
179+
# CLI-Hilfe
180+
python metawiki_cli.py --help
181+
182+
# Statistiken anzeigen
183+
python metawiki_cli.py stats
184+
185+
# Konsistenz pruefen
186+
python metawiki_cli.py check
187+
188+
# JSON nach Markdown exportieren
189+
python metawiki_pipeline.py export --output --english
190+
```
191+
192+
Unter Windows steht zusaetzlich `start.bat` als einfacher Einstieg fuer die CLI bereit. Exportierte Dateien landen in `output/`; dieser Ordner bleibt lokal und wird nicht versioniert.
193+
194+
## Datenschutz / Privacy
195+
196+
MetaWiki arbeitet standardmaessig lokal mit `metawiki.json` und den Markdown-Exporten in diesem Repository. Es gibt keine Telemetrie und keine automatische Netzwerkkommunikation.
197+
198+
Nur der optionale Befehl `python metawiki_pipeline.py translate` kann externe API-Aufrufe ausloesen, wenn `ANTHROPIC_API_KEY` gesetzt ist und das optionale Paket `anthropic` installiert wurde.
199+
176200
## Roadmap
177201

178202
### Phase 1 - Strukturaufbau `[ABGESCHLOSSEN]`
@@ -235,7 +259,7 @@ Ohne gesetzten `ANTHROPIC_API_KEY` oder ohne `pip install anthropic` wird die Ue
235259
| Projektagnostisch | Fuer jeden Anwendungsfall |
236260

237261
<p align="center">
238-
<sub>Built with brain and AI &nbsp;|&nbsp; Developed by <a href="https://github.com/lukisch">lukisch</a></sub>
262+
<sub>Built with brain and AI &nbsp;|&nbsp; Maintained at <a href="https://github.com/file-bricks/MetaWiki">file-bricks/MetaWiki</a></sub>
239263
</p>
240264

241265
---
@@ -373,7 +397,7 @@ All 630 stubs are already fully **bilingual (DE + EN)**. For new stubs added lat
373397

374398
```bash
375399
# Set API key and install optional package
376-
export ANTHROPIC_API_KEY="sk-ant-..."
400+
export ANTHROPIC_API_KEY="<your-anthropic-api-key>"
377401
pip install anthropic
378402

379403
# Translate all stubs (missing definition_en)
@@ -398,6 +422,30 @@ print(english)
398422

399423
Without a set `ANTHROPIC_API_KEY` or without `pip install anthropic`, translation is silently skipped.
400424

425+
### Usage
426+
427+
```bash
428+
# CLI help
429+
python metawiki_cli.py --help
430+
431+
# Show statistics
432+
python metawiki_cli.py stats
433+
434+
# Check consistency
435+
python metawiki_cli.py check
436+
437+
# Export JSON to Markdown
438+
python metawiki_pipeline.py export --output --english
439+
```
440+
441+
On Windows, `start.bat` provides a simple CLI entry point. Exported files are written to `output/`; that folder stays local and is not versioned.
442+
443+
### Privacy
444+
445+
MetaWiki works locally by default with `metawiki.json` and the Markdown exports in this repository. It has no telemetry and no automatic network communication.
446+
447+
Only the optional `python metawiki_pipeline.py translate` command can make external API calls when `ANTHROPIC_API_KEY` is set and the optional `anthropic` package is installed.
448+
401449
### Roadmap
402450

403451
#### Phase 1 - Structure Setup `[COMPLETED]`
@@ -460,16 +508,16 @@ Without a set `ANTHROPIC_API_KEY` or without `pip install anthropic`, translatio
460508
| Project-agnostic | For any use case |
461509

462510
<p align="center">
463-
<sub>Built with brain and AI &nbsp;|&nbsp; Developed by <a href="https://github.com/lukisch">lukisch</a></sub>
511+
<sub>Built with brain and AI &nbsp;|&nbsp; Maintained at <a href="https://github.com/file-bricks/MetaWiki">file-bricks/MetaWiki</a></sub>
464512
</p>
465513

466514
---
467515

468516
## Haftung / Liability
469517

470-
Dieses Projekt ist eine **unentgeltliche Open-Source-Schenkung** im Sinne der §§ 516 ff. BGB. Die Haftung des Urhebers ist gemäß **§ 521 BGB** auf **Vorsatz und grobe Fahrlässigkeit** beschränkt. Ergänzend gelten die Haftungsausschlüsse aus GPL-3.0 / MIT / Apache-2.0 §§ 15–16 (je nach gewählter Lizenz).
518+
Dieses Projekt ist eine **unentgeltliche Open-Source-Schenkung** im Sinne der §§ 516 ff. BGB. Die Haftung des Urhebers ist gemäß **§ 521 BGB** auf **Vorsatz und grobe Fahrlässigkeit** beschränkt. Ergänzend gelten die Haftungsausschlüsse der MIT-Lizenz.
471519

472520
Nutzung auf eigenes Risiko. Keine Wartungszusage, keine Verfügbarkeitsgarantie, keine Gewähr für Fehlerfreiheit oder Eignung für einen bestimmten Zweck.
473521

474-
This project is an unpaid open-source donation. Liability is limited to intent and gross negligence (§ 521 German Civil Code). Use at your own risk. No warranty, no maintenance guarantee, no fitness-for-purpose assumed.
522+
This project is an unpaid open-source donation. Liability is limited to intent and gross negligence (§ 521 German Civil Code), with the MIT License disclaimers applying as well. Use at your own risk. No warranty, no maintenance guarantee, no fitness-for-purpose assumed.
475523

SECURITY.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,12 +5,12 @@
55
If you find a security vulnerability, please report it responsibly:
66

77
1. **Do NOT open a public issue**
8-
2. **Use GitHub's [private vulnerability reporting](https://github.com/lukisch/MetaWiki/security/advisories/new)**
8+
2. **Use GitHub's [private vulnerability reporting](https://github.com/file-bricks/MetaWiki/security/advisories/new)**
99
3. Include: description, steps to reproduce, potential impact
1010

1111
### How to Report
1212

13-
1. Go to: https://github.com/lukisch/MetaWiki/security/advisories/new
13+
1. Go to: https://github.com/file-bricks/MetaWiki/security/advisories/new
1414
2. Fill out the form (title, description, severity, affected versions)
1515
3. Submit privately (not visible to public until disclosed)
1616

assets/metawiki_icon.png

20.1 KB
Loading

start.bat

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
@echo off
2+
chcp 65001 >nul
3+
set PYTHONIOENCODING=utf-8
4+
cd /d "%~dp0"
5+
set PYTHON=python
6+
%PYTHON% --version >nul 2>&1
7+
if errorlevel 1 (
8+
set PYTHON=py -3
9+
%PYTHON% --version >nul 2>&1
10+
if errorlevel 1 (
11+
echo [FEHLER] Python nicht gefunden!
12+
pause
13+
exit /b 1
14+
)
15+
)
16+
%PYTHON% metawiki_cli.py %*
17+
if errorlevel 1 pause

0 commit comments

Comments
 (0)