xcore-framework 0.1.0a2

CLI- und Webframework für modulare Anwendungen mit interaktiver Shell, GUI und Webinterface.

eine einfache modulare Anwendung, die verschiedene Funktionalitäten in Form von Modulen bereitstellt

---

Übersicht

Das XCORE Framework ist ein modulares, erweiterbares Framework für Python, das dir die zentrale Steuerung, Ausführung und Entwicklung von Automatisierungs-Tools, Sicherheitsmodulen, kreativen Helferskripten und systemnahen Anwendungen ermöglicht – egal ob über CLI, GUI oder Webinterface.

✨ Highlights

🔌 Plug-and-Play Module

• Lade, konfiguriere und starte Module nach Metasploit-Prinzip (use, options, run) – lokal oder remote.

🧠 Benutzerfreundlich & mehrsprachig

• Dynamische GUI mit automatischer Widget-Generierung für Moduloptionen, integrierter Übersetzungsunterstützung (i18n) und Benutzerverwaltung.

🌐 Drei Steuer-Interfaces

• CLI für Power-User
• Tkinter-GUI für Desktop
• Webinterface (Flask + React) für Remote-Zugriff und moderne UI

💾 Datenbankgestützte Moduloptionen

• Speichere benutzerdefinierte Einstellungen, lade sie später wieder oder verteile sie zentral.

⚒️ Dev Tools integriert

• Mitgelieferter module_creator, Setpoint-Editor, automatische Lokalisierung und ENV-Setup machen Entwicklung und Deployment effizient und konsistent.

Für eine umfassende Dokumentation siehe DOCUMENTATION_DE.md.

---

Installation

Voraussetzungen

• Python 3.8 oder höher
• pip (Python-Paketmanager)

Installation über pip

pip install xcore_framework

Installation aus dem Quellcode

1. Repository klonen:

   git clone https://github.com/x404bjrn/XCORE.git
   

2. In das Verzeichnis wechseln:

   cd XCORE
   

3. Abhängigkeiten installieren:

   pip install -r requirements.txt
   

4. Installation durchführen:

   pip install -e .
   

Paket erstellen

Wenn Sie das Paket erstellen und aus der Wheel-Datei installieren möchten:

1. Build-Paket installieren:

   pip install build
   

2. Paket erstellen:

   python -m build
   

3. Wheel-Datei installieren:

   pip install dist/*.whl
   

---

🚀 Schnellstart

CLI-Modus starten

xcore --cli

Web-Modus starten

xcore --web

Optionale Parameter:

• --host: Host-Adresse (Standard: 127.0.0.1)
• --port: Port (Standard: 5000)
• --debug: Debug-Modus aktivieren
• --open-browser: Browser automatisch öffnen (Standard: aktiviert)

Beispiel:

xcore --web --host 0.0.0.0 --port 8080 --debug

GUI-Modus starten

xcore --gui

Setpoint-Modus starten

xcore --setpoint

Optionale Parameter:

• --interface: Interface für den Konfigurationseditor (cli, gui, web) (Standard: gui)

Beispiel:

xcore --setpoint --interface cli

---

Eigene Module erstellen

Das XCORE Framework enthält ein grafisches Werkzeug zum Erstellen von Modulen, das sich unter dev/tools/module_creator.py befindet. Dieses Werkzeug vereinfacht den Prozess der Erstellung neuer Module, indem es eine benutzerfreundliche Oberfläche für die Definition von Modulmetadaten, Optionen und Internationalisierungszeichenketten bereitstellt.

Für detaillierte Informationen zur Erstellung eigener Module, siehe den Abschnitt Modulsystem in der Dokumentation.

---

Beitragen

Beiträge zum XCORE Framework sind willkommen! Hier sind einige Möglichkeiten, wie Sie beitragen können:

1. Fehler melden: Erstellen Sie ein Issue im GitHub-Repository, wenn Sie einen Fehler finden.
2. Funktionen vorschlagen: Haben Sie eine Idee für eine neue Funktion? Erstellen Sie ein Issue mit Ihrem Vorschlag.
3. Code beitragen: Forken Sie das Repository, nehmen Sie Ihre Änderungen vor und erstellen Sie einen Pull Request.
4. Module erstellen: Erstellen Sie neue Module, um die Funktionalität des Frameworks zu erweitern.

---

Lizenz

• Code: MIT-Lizenz – siehe LICENSE für Details
• Medieninhalte: CC BY 4.0 - siehe Creative Commons für Details

---

written on the dark side of toast 🍞🌚

© 2025, Xeniorn | x404bjrn