Nexy a Python framework designed to combine simplicity, performance, and the joy of development.
Project description
Nexy
Un framework Python moderne qui transforme le développement web en une expérience agréable et productive, construit sur la puissance de FastAPI.
📖 Table des Matières
- Introduction
- Installation
- Concepts Fondamentaux
- Routing
- Controllers
- Vues et Templates
- Actions et Interactivité
- Organisation du Code
- Déploiement
- Bonnes Pratiques
- FAQ
🌟 Introduction
Le Contexte
Le développement web en Python a toujours oscillé entre deux extrêmes :
- Des frameworks très complets mais complexes (comme Django)
- Des micro-frameworks flexibles mais nécessitant beaucoup de configuration (comme Flask)
FastAPI a révolutionné l'écosystème en apportant performance et typage moderne. Cependant, les développeurs font toujours face à des défis :
- Organisation complexe des projets grandissants
- Configuration répétitive des routes
- Manque de conventions claires
- Difficulté à gérer l'interface utilisateur
La Vision de Nexy
Nexy est né d'une idée simple : et si nous pouvions combiner la puissance de FastAPI avec une expérience développeur exceptionnelle ?
Nos principes :
- Convention over Configuration : Les bonnes pratiques par défaut
- Intuitivité : La structure doit être naturelle et évidente
- Productivité : Moins de code répétitif, plus de fonctionnalités
- Évolutivité : De la petite API au projet d'entreprise
🚀 Installation
Prérequis
- Python 3.12 ou supérieur
- pip (gestionnaire de paquets Python)
Installation Simple
pip install nexy inquirerpy=="0.3.4"
Création d'un Projet
nexy new mon-projet
cd mon-projet
Structure Initiale
mon-projet/
├── app/
│ ├── controller.py # Point d'entrée principal
│ └── view.html # Vue principale (optionnelle)
├── public/ # Fichiers statiques
└── nexy-config.py # Configuration de l'application
🎯 Concepts Fondamentaux
Le Routing Automatique
Nexy introduit un système de routing basé sur la structure des dossiers, inspiré des meilleures pratiques modernes.
Structure = Routes
app/
├── controller.py # Route: /
├── users/
│ ├── controller.py # Route: /users
│ └── [id]/ # Route dynamique
│ └── controller.py # Route: /users/{id}
└── blog/
├── controller.py # Route: /blog
└── posts/
└── controller.py # Route: /blog/posts
Les Controllers
Les controllers sont le cœur de votre application. Ils définissent comment votre application répond aux requêtes HTTP.
Controller Simple
# app/controller.py
async def GET():
"""Route principale : GET /"""
return {"message": "Bienvenue sur Nexy!"}
async def POST(data: dict):
"""Gestion des POST sur /"""
return {"received": data}
Controller avec Paramètres
# app/users/[id]/controller.py
async def GET(id: int):
"""Récupère un utilisateur par ID"""
return {"user_id": id, "name": "Alice"}
async def PUT(id: int, data: dict):
"""Met à jour un utilisateur"""
return {"updated": id, "data": data}
async def DELETE(id: int):
"""Supprime un utilisateur"""
return {"deleted": id}
Les Services
Les services permettent d'isoler la logique métier des controllers.
# app/users/service.py
class UserService:
def __init__(self):
self.users = []
def get_all(self):
return self.users
def add_user(self, user):
self.users.append(user)
return user
# app/users/controller.py
from .service import UserService
service = UserService()
async def GET():
return {"users": service.get_all()}
async def POST(data: dict):
return {"created": service.add_user(data)}
Les Vues
Nexy inclut un système de templates puissant pour créer des interfaces utilisateur dynamiques.
Vue Simple
<!-- app/view.html -->
<!DOCTYPE html>
<html>
<head>
<title>Mon App Nexy</title>
</head>
<body>
<h1>Bienvenue sur {{title}}</h1>
<ul>
{% for user in users %}
<li>{{user.name}}</li>
{% endfor %}
</ul>
</body>
</html>
Composants Réutilisables
<!-- app/components/button.html -->
{% macro Button(text, type="button") %}
<button
class="btn btn-{{type}}"
style="padding: 8px 16px; border-radius: 4px;">
{{text}}
</button>
{% endmacro %}
<!-- Utilisation dans une vue -->
{% from "app/components/button.html" import Button %}
<div>
{{ Button(text="Connexion", type="primary") }}
{{ Button(text="Annuler", type="secondary") }}
</div>
Les Layouts
Nexy supporte les layouts imbriqués pour une meilleure organisation des vues.
<!-- app/layout.html -->
<!DOCTYPE html>
<html>
<head>
<title>{% block title %}{% endblock %}</title>
</head>
<body>
<nav>
<!-- Navigation commune -->
</nav>
<main>
{{children | safe}}
</main>
<footer>
<!-- Footer commun -->
</footer>
</body>
</html>
[Suite dans la prochaine partie...]
🌟 Nexy
Un framework Python conçu pour allier simplicité, performance et plaisir du développement.
📢 Un message de l'équipe Nexy
⚠️ Cette documentation est en cours de création.
L'équipe de développement travaille activement sur un site dédié, pour offrir une documentation complète, claire et accessible. Notre objectif est de vous fournir une expérience développeur exceptionnelle, adaptée aussi bien aux débutants qu'aux experts.
🐍 La philosophie Python au cœur de Nexy
Python est un langage qui se distingue par sa simplicité, sa lisibilité et sa grande efficacité. C'est cette philosophie qui a inspiré Nexy : rendre le développement plus simple, plus rapide, mais sans jamais sacrifier la performance.
Un constat
Aujourd'hui, Python regorge de frameworks backend puissants, tels que :
- Flask
- FastAPI
- Starlette, etc.
Ces outils sont indéniablement performants et modulaires, mais leur documentation peut parfois être intimidante et les configurations complexes. Même un framework complet comme Django peut parfois sembler lourd et difficile à aborder, même pour les développeurs expérimentés.
Nexy : simplicité et efficacité
Chez Nexy, nous croyons que simple ne signifie pas limité.
Nous avons conçu Nexy pour que les développeurs puissent se concentrer sur l'essentiel sans avoir à se perdre dans des configurations complexes.
Ce que nous vous proposons :
- Démarrage rapide : Pas de longue configuration. Vous êtes opérationnel en quelques lignes de code.
- Code propre et modulaire : Organisez vos projets de manière fluide et maintenez un code lisible, même pour des projets de grande envergure.
- Performance optimale : Profitez de la rapidité de Python tout en préservant la simplicité.
Le code, c'est de l'art. Chez Nexy, chaque ligne doit être un plaisir à écrire, et votre expérience développeur compte autant que la performance du code.
🎯 Nos Objectifs
- Expérience développeur : Rendre chaque étape du projet, du démarrage au déploiement, intuitive et agréable.
- Performance : Maximiser les performances sans sacrifier la simplicité.
- Simplicité évolutive : Débutez simplement et restez productif même lorsque votre projet se complexifie.
Ce qui nous différencie :
- Structure modulaire : Organisez vos projets de manière claire et évolutive.
- Configuration automatique : Nexy détecte automatiquement les routes et fichiers sans que vous ayez à vous en soucier.
- Philosophie "Plug & Play" : Avancez rapidement sans perdre de temps dans des configurations compliquées.
📂 Structure de Projet
Voici un exemple d'organisation typique avec Nexy :
nexy/
├── app/
│ ├── controller.py # Contrôleur principal pour `/`
│ ├── model.py # Gestion des données pour `/`
│ ├── service.py # Logique métier pour `/`
│ ├── documents/ # Endpoint `/documents`
│ │ ├── controller.py # Contrôleur pour `/documents`
│ │ ├── model.py # Gestion des données pour `/documents`
│ │ ├── service.py # Logique métier pour `/documents`
│ │ └── [documentId]/ # Endpoint dynamique `/documents/{documentId}`
│ │ ├── controller.py
│ │ ├── model.py
│ │ └── service.py
│ └── users/
│ ├── controller.py # Contrôleur pour `/users`
│ ├── model.py # Gestion des données pour `/users`
│ └── service.py # Logique métier pour `/users`
└── main.py # Point d'entrée de l'application
💡 Astuce : La structure des dossiers reflète vos routes, vous offrant ainsi une lisibilité immédiate et une organisation naturelle.
Pré-requis
Veuillez vous assurer que vous utilisez
Python >= 3.12, car Nexy n'est pas compatible avec les versionsPython < 3.12.
Comment vérifier votre version de Python ?
Exécutez cette commande dans votre terminal :
python --version
🚀 Installation et Démarrage
Étape 1 : Créez un répertoire pour votre projet et placez-vous dedans
- Installez Nexy et ses dépendances :
pip install nexy inquirerpy=="0.3.4"
Votre API est maintenant accessible sur http://127.0.0.1:8000 🎉
Une fois que l'application est en cours d'exécution, tu peux accéder à la documentation Swagger en naviguant vers http://localhost:8000/docs dans ton navigateur.
🧩 Concepts Clés avec des Exemples
1. Contrôleur de Base
Chaque route est définie dans un fichier controller.py. Exemple :
# app/controller.py
async def GET():
return {"message": "Hello, world"}
async def POST(data: dict):
return {"message": "Voici vos données", "data": data}
2. Routes Dynamiques
Les routes dynamiques sont automatiquement détectées :
app/documents/[documentId]/controller.py
# app/documents/[documentId]/controller.py
async def GET(documentId: int):
return {"documentId": documentId, "message": "Document trouvé"}
3. Architecture Modulaire avec model et service
Séparez la logique métier et la gestion des données :
# app/users/controller.py
from .service import get_users, add_user
async def GET():
users = get_users()
return {"users": users}
async def POST(user: dict):
return add_user(user)
# app/users/service.py
from .model import User
def get_users():
return User.all()
def add_user(data: dict):
user = User(**data)
user.save()
return {"message": "Utilisateur ajouté", "user": user}
📚 Pourquoi Nexy ?
- Pour les débutants : Vous trouverez une approche simple, sans surcharge de concepts, pour apprendre à coder rapidement.
- Pour les experts : La structure modulaire et la performance vous permettront de réaliser des projets de grande envergure tout en gardant un code propre et bien organisé.
- Pour tous les développeurs : Profitez de la facilité d'utilisation tout en écrivant un code performant et élégant.
Avec Nexy, vous allez découvrir un framework simple, puissant et agréable à utiliser. Ce n'est pas seulement un framework : c'est un outil pour libérer votre créativité, accélérer votre développement, et surtout, vous faire apprécier chaque ligne de code.
📢 Contribuez à Nexy !
🚀 Nexy est open-source et vous attend sur GitHub. Partagez vos idées, améliorez le framework et faites partie de la révolution backend Python.
💡 Nexy : Plus qu'un framework, un outil pour vous.
🔄 Actions et Interactivité
Le Système d'Actions
Nexy introduit un système d'actions puissant qui permet de créer des interfaces interactives sans écrire de JavaScript complexe.
Actions Simples
<!-- Bouton qui déclenche une action -->
<button action="increment">
Augmenter le compteur
</button>
<!-- Zone qui se met à jour automatiquement -->
<div response="counter">
Compteur: {{count}}
</div>
# app/actions.py
count = 0
def increment():
global count
count += 1
return count
Actions avec Paramètres
<form action="add_user" method="post">
<input type="text" name="name">
<button type="submit">Ajouter</button>
</form>
<ul response="users">
{% for user in users %}
<li>
{{user.name}}
<button action="delete_user" data-id="{{user.id}}">❌</button>
</li>
{% endfor %}
</ul>
Gestion d'État
Nexy permet de gérer l'état de votre application de manière simple et efficace.
# app/state.py
from nexy import State
users = State([]) # État initial
def add_user(name: str):
users.set([*users.get(), {"name": name}])
return users.get()
def remove_user(id: int):
users.set([u for u in users.get() if u.id != id])
return users.get()
📦 Organisation du Code
Structure Recommandée
mon-projet/
├── app/
│ ├── controller.py # Contrôleur principal
│ ├── view.html # Vue principale
│ ├── actions.py # Actions globales
│ ├── components/ # Composants réutilisables
│ │ ├── Button.html
│ │ └── Card.html
│ ├── users/ # Module Users
│ │ ├── controller.py
│ │ ├── view.html
│ │ ├── actions.py
│ │ └── service.py
│ └── blog/ # Module Blog
│ ├── controller.py
│ ├── view.html
│ └── [slug]/
│ └── controller.py
├── public/ # Fichiers statiques
│ ├── css/
│ ├── js/
│ └── images/
├── tests/ # Tests
└── nexy-config.py # Configuration
Bonnes Pratiques
1. Organisation Modulaire
Regroupez les fonctionnalités liées dans des modules :
app/users/
├── controller.py # Gestion des requêtes
├── service.py # Logique métier
├── view.html # Interface utilisateur
└── actions.py # Interactions utilisateur
2. Séparation des Responsabilités
# app/users/controller.py
from .service import UserService
service = UserService()
async def GET():
return service.get_users()
# app/users/service.py
class UserService:
def get_users(self):
# Logique métier isolée
return [...]
🛠️ Outils de Développement
CLI Nexy
# Création
nexy new mon-projet # Nouveau projet
nexy g co users # Nouveau controller
nexy g s users # Nouveau service
# Développement
nexy dev # Serveur de développement
nexy build # Construction pour production
Hot Reload
Nexy inclut un système de rechargement automatique en développement :
- Modifications de code Python
- Changements dans les templates
- Mise à jour des fichiers statiques
🚀 Déploiement
Construction pour Production
nexy build
Configuration de Production
# nexy-config.py
from nexy import Nexy
app = Nexy(
production=True,
static_cache=True
)
Plateformes Supportées
- Vercel
- Heroku
- Docker
- VPS classique
🎯 Exemples Complets
1. Application Todo
# app/todos/controller.py
from nexy import HTMLResponse, CustomResponse
todos = []
@CustomResponse(type=HTMLResponse)
async def GET():
return {"todos": todos}
async def POST(data: dict):
todos.append(data)
return {"status": "success"}
<!-- app/todos/view.html -->
{% from "app/components/button.html" import Button %}
<div class="todos">
<form action="add" method="post">
<input type="text" name="task" placeholder="Nouvelle tâche">
{{ Button(text="Ajouter") }}
</form>
<ul response="todos">
{% for todo in todos %}
<li>
{{todo.task}}
<button action="delete" data-id="{{loop.index}}">
Supprimer
</button>
</li>
{% endfor %}
</ul>
</div>
2. API REST
# app/api/users/controller.py
from typing import List
from pydantic import BaseModel
class User(BaseModel):
id: int
name: str
email: str
users: List[User] = []
async def GET():
return {"users": users}
async def POST(user: User):
users.append(user)
return {"status": "created", "user": user}
🤝 Contribution
- Fork le projet
- Créez votre branche (
git checkout -b feature/AmazingFeature) - Committez vos changements (
git commit -m 'Add AmazingFeature') - Push vers la branche (
git push origin feature/AmazingFeature) - Ouvrez une Pull Request
📚 Ressources
❓ FAQ
Q: Nexy est-il prêt pour la production ?
R: Oui ! Nexy est construit sur FastAPI et suit les meilleures pratiques de développement.
Q: Puis-je utiliser Nexy pour des APIs uniquement ?
R: Absolument ! Bien que Nexy excelle dans les applications full-stack, il est parfait pour les APIs REST.
Q: Comment contribuer à Nexy ?
R: Consultez notre guide de contribution et rejoignez notre Discord !
🌟 Pour Finir
Nexy est plus qu'un framework - c'est une nouvelle façon de penser le développement web en Python. Simple mais puissant, il vous permet de vous concentrer sur ce qui compte vraiment : créer des applications exceptionnelles.
Fait avec ❤️ par la communauté Python
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file nexy-0.0.47.tar.gz.
File metadata
- Download URL: nexy-0.0.47.tar.gz
- Upload date:
- Size: 29.9 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.13.2 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
5ebef01a59cc9e4cc31bfb7f8b417a66ef4d3ed1d629b10458f3c4e8cfca8daf
|
|
| MD5 |
36e1273f2bd2ca194e3c9959e498bdcd
|
|
| BLAKE2b-256 |
27c2b2f895fb7384991504740cd9ab15d511fb8afcd55a29d5e00e7c96e92df4
|
File details
Details for the file nexy-0.0.47-py3-none-any.whl.
File metadata
- Download URL: nexy-0.0.47-py3-none-any.whl
- Upload date:
- Size: 36.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: poetry/1.8.4 CPython/3.13.2 Windows/11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
b43a9313a33a9e7f7f5ac06b6c933fcf4b6cd99f78e0db1e8888b003ee1fd08c
|
|
| MD5 |
109b07913593193f0e0e7d169260478e
|
|
| BLAKE2b-256 |
987208c8267063816d174d264a15fe4aabef75be54c26787335163188cb4a273
|
