Votre projet

Créez un répertoire pour votre projet et allez dans ce répertoire:

$ mkdir flask-tutorial
$ cd flask-tutorial

Ensuite suivez le document installation instructions pour créer un environnement virtual Python et installer Flask pour votre projet.

Ce tutorial suppose que vous travaillez depuis un répertoire dénommé flask-tutorial. Les noms de fichiers spécifiés au-dessus de chaque bloc de code sont relatifs à ce répertoire.

Une application Flaks peut être aussi petite qu’un seul fichier.

hello.py
from flask import Flask

app = Flask(__name__)


@app.route('/')
def hello():
    return 'Hello, World!'

Cependant, lorsque le projet grandit, il devient plus difficile de garder l’ensemble du code dans un seul fichier. Les projets Python utilisent la notion de package pour organiser le code en différents modules qui peuvent être importés où ils sont nécessaires. Ce tutorial fera de même.

Le répertoire du projet contiendra:

  • flaskr/, un package Python contenant le code de votre application et les fichiers associés.

  • test/, un répertoire contenant les modules de test.

  • venv/, un environnement virtuel Python où Flask et d’autres dépendances sont installés.

  • Des fichiers d’installation qui indiquent à Python comment installer votre projet.

  • La configuration de votre système de contrôle de version tel que git. Vous devriez prendre l’habitude d’utiliser un système de contrôle de version pour tous vos projets, quelle que soit leur taille.

  • D’autres fichiers liés au projet que vous pourriez ajouter par après.

A la fin, votre répertoire de projet devrait ressemble à:

/home/user/Projects/flask-tutorial
├── flaskr/
│   ├── __init__.py
│   ├── db.py
│   ├── schema.sql
│   ├── auth.py
│   ├── blog.py
│   ├── templates/
│   │   ├── base.html
│   │   ├── auth/
│   │   │   ├── login.html
│   │   │   └── register.html
│   │   └── blog/
│   │       ├── create.html
│   │       ├── index.html
│   │       └── update.html
│   └── static/
│       └── style.css
├── tests/
│   ├── conftest.py
│   ├── data.sql
│   ├── test_factory.py
│   ├── test_db.py
│   ├── test_auth.py
│   └── test_blog.py
├── venv/
├── setup.py
└── MANIFEST.in

Si vous utilisez un outil de contrôle de version, les fichiers suivants qui sont générés durant l’exécution de votre projet doivent être ignorés. Il peut y avoir d’autres fichiers en fonction de l’éditeur de textes que vous utilisez. En général, ignorez les fichiers que vous n’avez pas écrit vous-même. Par exemple, pour git cela donne:

.gitignore
venv/

*.pyc
__pycache__/

instance/

.pytest_cache/
.coverage
htmlcov/

dist/
build/
*.egg-info/

Continue en lisant le document Configuration de l’application.