Skip to content

Commit 805e60f

Browse files
author
Lukas Geiger
committed
docs: update workspace exchange docs and add pyproject.toml
1 parent fa7eef2 commit 805e60f

7 files changed

Lines changed: 97 additions & 21 deletions

File tree

.gitignore

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# =============================================================================
1+
# =============================================================================
22
# .gitignore Template fuer Software Entwicklung Projekte
33
# Kopieren und als .gitignore im Projektroot ablegen
44
# Projektspezifische Eintraege am Ende anfuegen
@@ -100,3 +100,7 @@ Profiler.txt
100100
Integration aller Tools prompt.txt
101101
import_daten.xlsx
102102
indent_log.txt
103+
DECISIONS.md
104+
PORTIERUNGSPLAN.md
105+
TODO.md
106+
DONE.md

CHANGELOG.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ Format basiert auf [Keep a Changelog](https://keepachangelog.com/de/1.1.0/).
1111
- ProSync kann aus dem Tools-Menü optional gestartet werden.
1212
- `README_de.md` als separate deutsche README und `llms.txt` als maschinenlesbarer Projektkontext ergänzt.
1313
- Redigierter Workspace-Austausch über `profiler-workspace-v1.json` mit Menüaktionen für Export und Import ergänzt.
14+
- `pyproject.toml` zur Standardisierung der Paketmetadaten und Abhängigkeiten angelegt.
1415

1516
### Geändert / Changed
1617
- `profiler_settings.json` um `prosync_path` erweitert.

EXPORTFORMAT.md

Lines changed: 50 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,62 +1,95 @@
11
# Exportformat - ProFiler Suite
22

3-
Stand: 2026-06-01
3+
Stand: 2026-06-03
44

55
## Zweck
66

7-
`profiler-workspace-v1.json` ist ein geplantes dateibasiertes Austauschformat für ProFiler. Es dient dem Wechsel zwischen Desktop-Installationen, macOS-/Linux-Smokes und optionalen redigierten Review-Situationen. Es ist kein Synchronisationsprotokoll und kein Rohdokument-Archiv.
7+
`profiler-workspace-v1.json` ist ein redigiertes Austauschformat für ProFiler. Es dient der Übergabe zwischen Desktop-Installationen, der Vorbereitung von macOS-/Linux-Smokes und sicheren Review-Situationen. Es ist kein Rohdokument-Archiv und kein Synchronisationsprotokoll.
88

99
## Grundsätze
1010

1111
- keine Rohdokumente
1212
- keine Secrets, Tokens, Passwörter oder OAuth-Daten
1313
- keine ungefragten absoluten Benutzerpfade
14-
- Datenschutzfunde nur als redigierte Zusammenfassung
15-
- Schema-Version immer explizit führen
14+
- Indexe nur als Zusammenfassung mit redigierten Wurzelreferenzen
15+
- Datenschutzampel nur als Regel-/Status-Zusammenfassung
16+
- sichere Einstellungen dürfen importiert werden; lokale Pfade bewusst nicht
1617

17-
## Geplante Struktur
18+
## Aktuelle Struktur
1819

1920
```json
2021
{
2122
"schema": "profiler-workspace-v1",
22-
"exported_at": "2026-06-01T00:00:00+02:00",
23+
"schema_version": 1,
24+
"exported_at": "2026-06-03T12:00:00Z",
2325
"app": {
2426
"name": "ProFiler Suite",
2527
"version": "15"
2628
},
2729
"workspace": {
28-
"name": "Beispielarchiv",
29-
"notes": "Redigierter Export ohne Rohdokumente"
30+
"name": "ProFiler Workspace (2 Verbindungen)",
31+
"notes": "Redigierter Export ohne Rohdokumente und ohne lokale Benutzerpfade.",
32+
"connection_count": 2,
33+
"enabled_connection_count": 2
3034
},
3135
"settings": {
32-
"ui_language": "de",
3336
"theme": "dark",
34-
"ocr_languages": ["deu", "eng"]
37+
"delete_mode": "soft",
38+
"ocr_enabled": true,
39+
"ocr_language": "deu",
40+
"ocr_languages": ["deu"]
3541
},
3642
"indexes": [
3743
{
38-
"id": "local-documents",
44+
"id": "local-docs",
3945
"label": "Dokumente",
4046
"file_count": 1240,
41-
"redacted_root": "[LOCAL_ARCHIVE]",
42-
"formats": ["pdf", "docx", "txt", "png"]
47+
"redacted_root": "[source-root-1]/Dokumente",
48+
"formats": ["docx", "pdf", "txt"],
49+
"enabled": true,
50+
"sources_count": 1,
51+
"status": "ready"
4352
}
4453
],
4554
"privacy_summary": {
46-
"status": "needs_review",
47-
"sensitive_hit_count": 12,
48-
"categories": ["personenbezogen", "finanzen"]
55+
"status": "rules_configured",
56+
"sensitive_hit_count": 0,
57+
"categories": [],
58+
"blacklist_terms_count": 12,
59+
"whitelist_terms_count": 4,
60+
"clipboard_lock": true,
61+
"whole_words": true,
62+
"case_sensitive": false
4963
},
5064
"tool_links": {
5165
"prosync": {
5266
"enabled": true,
5367
"configured": false
68+
},
69+
"sqlite_viewer": {
70+
"configured": false
71+
},
72+
"formconstructor": {
73+
"configured": false
74+
},
75+
"datenschutzampel": {
76+
"configured": true
5477
}
78+
},
79+
"redactions": {
80+
"paths": true,
81+
"secrets": true,
82+
"raw_documents": false
5583
}
5684
}
5785
```
5886

87+
## Importverhalten
88+
89+
- übernommen werden nur sichere Einstellungen wie OCR-Sprache, Löschmodus oder UI-bezogene Optionen
90+
- nicht übernommen werden lokale Datenbankpfade, Companion-Pfade, PDF-Masterpasswörter und sonstige Secrets
91+
- der importierte Snapshot wird lokal als Vorschau gespeichert, damit Review-Daten sichtbar bleiben, ohne produktive Indexe umzubiegen
92+
5993
## Abgrenzung
6094

6195
Das Format ersetzt keine Datenbankmigration und keine Dateisynchronisation. Für echte Dokumentübertragung nutzt der Anwender normale Dateiwege wie lokale Kopie, Backup, USB, Netzlaufwerk oder bewusst gewählte Cloud-Ordner.
62-

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ It is built for users who manage many local documents and want search, preview,
1616
- Privacy traffic light for finding potentially sensitive files before sharing or archiving
1717
- Cloud-placeholder awareness for OneDrive-style local file libraries
1818
- Optional ProSync companion launcher for folder synchronization workflows
19+
- Redacted workspace export/import for reviews, handoffs, and cross-platform smoke preparation
1920
- Desktop GUI with dark/light theme support and system tray integration
2021
- Included helper tools for SQLite inspection and Excel import
2122

@@ -110,4 +111,3 @@ This project uses PySide6 and PyMuPDF among other dependencies; see `requirement
110111
## Discoverability Keywords
111112

112113
`local-first file manager`, `desktop document manager`, `private document archive`, `OCR desktop app`, `PDF OCR tool`, `PDF redaction`, `document privacy checker`, `PySide6 file management`, `SQLite document index`, `Windows file organizer`.
113-

README_de.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,7 @@ ProFiler richtet sich an Menschen, die viele lokale Dokumente verwalten und Such
1616
- Datenschutzampel zum Auffinden potenziell sensibler Dateien vor Weitergabe oder Archivierung
1717
- Erkennung von Cloud-Platzhaltern für OneDrive-ähnliche lokale Bibliotheken
1818
- Optionaler ProSync-Companion für Ordner-Synchronisationsworkflows
19+
- Redigierter Arbeitsstand-Export/-Import für Review, Übergabe und Cross-Platform-Smokes
1920
- Desktop-GUI mit Dark-/Light-Theme und System-Tray-Integration
2021
- Enthaltene Hilfswerkzeuge für SQLite-Prüfung und Excel-Import
2122

@@ -106,4 +107,3 @@ ProFiler unterstützt Datenschutz-Workflows, Schwärzung und Anonymisierung, gar
106107
ProFiler Suite steht unter AGPL-3.0. Siehe [LICENSE](LICENSE).
107108

108109
Dieses Projekt verwendet unter anderem PySide6 und PyMuPDF; siehe `requirements.txt` und `THIRD_PARTY_LICENSES.txt`.
109-

llms.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,7 @@ Important capabilities:
2323
- duplicate and version review via SHA-256 fingerprints
2424
- privacy review and redaction/anonymization assistance
2525
- optional ProSync companion launcher
26+
- redacted workspace export/import for reviews and handoffs
2627

2728
Privacy note:
2829

@@ -40,4 +41,3 @@ Search phrases:
4041
- PySide6 file management
4142
- SQLite document index
4243
- Windows file organizer
43-

pyproject.toml

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
[build-system]
2+
requires = ["setuptools>=61.0.0", "wheel"]
3+
build-backend = "setuptools.build_meta"
4+
5+
[project]
6+
name = "profiler-suite"
7+
version = "15.0.0"
8+
description = "Local-first desktop file and document manager with search, preview, and privacy inspection."
9+
readme = "README.md"
10+
requires-python = ">=3.10"
11+
license = {text = "AGPL-3.0"}
12+
authors = [
13+
{name = "file-bricks Contributors"}
14+
]
15+
classifiers = [
16+
"Programming Language :: Python :: 3",
17+
"Programming Language :: Python :: 3.10",
18+
"Programming Language :: Python :: 3.11",
19+
"Programming Language :: Python :: 3.12",
20+
"License :: OSI Approved :: GNU Affero General Public License v3",
21+
"Operating System :: Microsoft :: Windows",
22+
"Topic :: Desktop Environment :: File Managers",
23+
]
24+
dependencies = [
25+
"PySide6>=6.5.0",
26+
"PyPDF2>=3.0.0",
27+
"pikepdf>=8.0.0",
28+
"PyMuPDF>=1.23.0",
29+
"pdf2image>=1.16.0",
30+
"python-docx>=1.0.0",
31+
"pytesseract>=0.3.10",
32+
"Pillow>=10.0.0",
33+
"watchdog>=3.0.0",
34+
"reportlab>=4.0.0",
35+
]
36+
37+
[project.urls]
38+
Homepage = "https://github.com/file-bricks/ProFiler"

0 commit comments

Comments
 (0)