Metadata-Version: 2.4
Name: velmu
Version: 1.0.1
Summary: A Python wrapper for the Velmu API
Author-email: Velmu Team <dev@velmu.com>
License: MIT License
        
        Copyright (c) 2025 Velmu
        
        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.
        
Project-URL: Homepage, https://velmu.com
Project-URL: Bug Tracker, https://github.com/velmu/issues
Keywords: velmu,api,wrapper,bot,sdk
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Internet :: WWW/HTTP
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: aiohttp>=3.8.0
Requires-Dist: python-socketio>=5.0.0
Requires-Dist: websockets>=10.0
Dynamic: license-file

# Velmu Python SDK

Une bibliothèque Python moderne, robuste et asynchrone pour interagir avec l'API Velmu et créer des bots puissants.

## Fonctionnalités Principales

- **100% Asynchrone** : Construit sur `asyncio` et `aiohttp` pour des performances élevées.
- **Temps Réel** : Connexion WebSocket persistante avec gestion automatique des reconnexions.
- **Système de Commandes** : Extension `commands` puissante (inspirée de discord.py) pour créer des bots facilement.
- **Gestion des Permissions** : Système fin de permissions (Bitwise flags) compatible avec l'architecture backend.
- **Historique et Pagination** : Itérateurs asynchrones performants pour parcourir l'historique des messages.
- **Typage Fort** : Modèles objets complets (`Member`, `Role`, `Guild`, `Channel`) pour une excellente expérience développeur (DX).

## Installation

Vous pouvez installer la bibliothèque directement depuis les sources :

```bash
pip install .
```

## Démarrage Rapide

Voici un bot minimal utilisant l'extension `commands` :

```python
import velmu
from velmu.ext import commands
import os

# Configuration
intents = velmu.Intents.default()
intents.message_content = True

bot = commands.Bot(command_prefix='!', intents=intents)

@bot.event
async def on_ready():
    print(f'Prêt ! Connecté en tant que {bot.user}')

@bot.command()
async def ping(ctx):
    await ctx.reply('Pong ! 🏓')

bot.run("VOTRE_TOKEN")
```

## Exemples

Des exemples complets sont disponibles dans le dossier `examples/` :

- **[basic_bot.py](examples/basic_bot.py)** : Bot basique avec commandes simples.
- **[moderation.py](examples/moderation.py)** : Démonstration du système de permissions (Kick, Ban, Checks).
- **[history.py](examples/history.py)** : Utilisation de `ctx.channel.history()` pour lire les anciens messages.

## Structure du Projet

- `velmu/` : Code source de la bibliothèque.
  - `client.py` : Client WebSocket et gestion des événements.
  - `api.py` : Client HTTP REST.
  - `ext/commands/` : Framework de commandes.
  - `models/` : Modèles de données (User, Guild, Channel...).
- `examples/` : Scripts d'exemple.

## Licence

Distribué sous la licence MIT.
