Metadata-Version: 2.4
Name: xcore_framework
Version: 0.1.0a2
Summary: CLI- und Webframework für modulare Anwendungen mit interaktiver Shell, GUI und Webinterface.
Author-email: "x404bjrn (Björn Häusermann)" <void@insomnialegion.xyz>
License: MIT License
        
        Copyright (c) 2025 -... .--- .-. -. | Björn Häusermann
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
        ---
        
        🔸 **Media Notice:**
        
        All graphical assets (including but not limited to icons, images, logos, and visual components) included in this repository are licensed under the **Creative Commons Attribution 4.0 International License (CC BY 4.0)**.
        
        ➡️ You must give appropriate credit, such as:
        > Icons and graphics by **Björn Häusermann (x404bjrn) / Xeniorn**
        
        Learn more: https://creativecommons.org/licenses/by/4.0/
        
Project-URL: Homepage, https://github.com/x404bjrn/XCORE
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Environment :: Console
Classifier: Framework :: Flask
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: setuptools~=78.1.0
Requires-Dist: python-dotenv~=1.1.0
Requires-Dist: googletrans~=4.0.0rc1
Requires-Dist: Flask~=3.1.1
Requires-Dist: Flask-Login~=0.6.3
Requires-Dist: Werkzeug~=3.1.3
Requires-Dist: flask-cors~=6.0.0
Requires-Dist: colorama~=0.4.6
Requires-Dist: pytest~=8.4.0
Requires-Dist: qrcode~=8.2
Requires-Dist: pillow~=11.2.1
Requires-Dist: cryptography~=45.0.4
Requires-Dist: flask-sqlalchemy~=3.1.1
Provides-Extra: dev
Requires-Dist: pytest; extra == "dev"
Requires-Dist: flake8; extra == "dev"
Requires-Dist: black; extra == "dev"
Requires-Dist: mypy; extra == "dev"
Dynamic: license-file

<br/>

<p align="center">
  <img src="https://github.com/x404bjrn/XCORE/blob/main/design/graphics/svg/xcore_full_green.svg" width=350px alt="">
    <br/><br/>
    <b>eine einfache modulare Anwendung, die verschiedene Funktionalitäten in Form von Modulen bereitstellt</b>
</p>

<p align="center">
    <a href="LICENSE"><img src="https://img.shields.io/badge/Code-MIT-yellow.svg" alt=""></a>
    <a href=""><img src="https://img.shields.io/badge/powered%20by-Xeniorn-4770DB" alt=""></a>
    <a href="https://creativecommons.org/licenses/by/4.0/"><img src="https://img.shields.io/badge/Media-CC%20BY%204.0-lightgrey.svg" alt=""></a>
    <a href="https://github.com/x404bjrn"><img src="https://img.shields.io/badge/written%20by-x404bjrn-8A2BE2" alt=""></a>
</p>

---

![DE](https://img.shields.io/badge/DE-green?style=for-the-badge)
[![EN](https://img.shields.io/badge/EN-blue?style=for-the-badge)](https://github.com/x404bjrn/XCORE/blob/main/docs/README_EN.md)

## Ü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](https://github.com/x404bjrn/XCORE/blob/main/docs/DOCUMENTATION_DE.md).

---

## Installation

### Voraussetzungen

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

### Installation über pip

```bash
pip install xcore_framework
```

### Installation aus dem Quellcode

1. Repository klonen:
   ```bash
   git clone https://github.com/x404bjrn/XCORE.git
   ```

2. In das Verzeichnis wechseln:
   ```bash
   cd XCORE
   ```

3. Abhängigkeiten installieren:
   ```bash
   pip install -r requirements.txt
   ```

4. Installation durchführen:
   ```bash
   pip install -e .
   ```

### Paket erstellen

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

1. Build-Paket installieren:
   ```bash
   pip install build
   ```

2. Paket erstellen:
   ```bash
   python -m build
   ```

3. Wheel-Datei installieren:
   ```bash
   pip install dist/*.whl
   ```

---

## 🚀 Schnellstart

### CLI-Modus starten

```bash
xcore --cli
```

### Web-Modus starten

```bash
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:
```bash
xcore --web --host 0.0.0.0 --port 8080 --debug
```

### GUI-Modus starten

```bash
xcore --gui
```

### Setpoint-Modus starten

```bash
xcore --setpoint
```

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

Beispiel:
```bash
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](https://github.com/x404bjrn/XCORE/blob/main/docs/DOCUMENTATION_DE.md#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](https://github.com/x404bjrn/XCORE/blob/main/LICENSE) für Details
- **Medieninhalte**: CC BY 4.0 - siehe [Creative Commons](https://creativecommons.org/licenses/by/4.0/) für Details

---

## written on the dark side of toast 🍞🌚  
#### © 2025, Xeniorn | [`x404bjrn`](https://github.com/x404bjrn)
