Passer au contenu principal

​
🚀 Introduction

  • Avant de commencer, assurez-vous que Python est installé sur votre système. Si ce n’est pas encore le cas, vous pouvez le télécharger depuis le site officiel de Python.
  • Ensuite, vous devrez créer un compte sur Square Cloud, ce qui peut être fait via la page de connexion. Vous pouvez utiliser votre e-mail, GitHub, ou les deux pour créer le compte.
  • Enfin, vous devez disposer d’un forfait payant actif sur votre compte. Vous pouvez consulter nos forfaits et en acheter un selon vos besoins ici.

​
⚙️ Configuration du fichier squarecloud.app

Si vous téléversez votre application via le site Web de Square Cloud, vous pouvez ignorer cette section. Le site crée automatiquement le fichier de configuration squarecloud.app pour vous.

En savoir plus : comment créer le fichier de configuration pour Square Cloud.

Le fichier squarecloud.app est un fichier de configuration qui sera utilisé pour configurer votre application ; il servira à définir le nom, la description, la version, le fichier principal, entre autres choses.

​
📄 Fichiers requis

  • Si le champ START n’est pas défini dans le fichier de configuration, Square Cloud exécutera python MAIN pour lancer le fichier Python spécifié dans MAIN. Si le champ START est défini dans le fichier de configuration, sa valeur sera exécutée directement. Pour plus d’informations sur les paramètres du fichier de configuration, consultez les paramètres de configuration.
  • Square Cloud utilise pip install pour installer toutes les dépendances listées dans requirements.txt.

​
🖥️ Préparation du projet

​
📁 Fichiers de configuration essentiels

Lors de la préparation de votre projet Python pour le deploy sur Square Cloud, assurez-vous d’inclure le fichier de configuration (squarecloud.app/.config) et les fichiers essentiels de votre application dans un fichier zip.
Le fichier de configuration (squarecloud.app/.config) doit se trouver à la racine du fichier zip. Sinon, Square Cloud ne pourra pas le trouver lors du deploy.

​
🗑️ Fichiers à exclure avant le téléversement

  • ffmpeg : Ce logiciel est préinstallé dans l’environnement Square Cloud, il n’est donc pas nécessaire de l’inclure dans votre projet.
  • .venv : Ce dossier contient l’environnement virtuel de votre projet. Square Cloud fournit un environnement isolé, il n’est donc pas nécessaire de téléverser ce dossier.
  • poetry.lock : Comme Square Cloud ne prend pas actuellement en charge Poetry, ce fichier doit être exclu pour éviter les problèmes de compatibilité lors du deploy.

​
🤔 Pourquoi exclure ces fichiers ?

Exclure ffmpeg, .venv et poetry.lock est important pour plusieurs raisons :
  1. Environnement propre : Square Cloud crée un nouvel environnement pour votre projet. Inclure ces fichiers est inutile et peut provoquer des conflits avec les configurations de l’environnement cloud.
  2. Efficacité : Supprimer ces fichiers réduit la taille du téléversement, rendant le processus plus rapide et plus léger.
  3. Compatibilité : Exclure poetry.lock évite les problèmes de compatibilité, car Square Cloud utilise requirements.txt pour installer les dépendances.
Avant le téléversement, compressez les fichiers de votre projet au format .zip, en excluant les fichiers inutiles mentionnés ci-dessus. Cela contribuera à garantir que votre application Python est prête pour un deploy réussi sur Square Cloud.

​
📄 Fichiers requis

  • main.py (Exemple de fichier principal).
  • requirements.txt (Fichier de dépendances).
  • OU [pyproject.toml] (Fichier de dépendances).
  • squarecloud.app (fichier contenant la configuration Square Cloud).

​
💡 Dépannage

Cette erreur se produit lorsque le fichier défini comme « main » de votre application dans le fichier de configuration n’existe pas, est mal écrit, ou que le chemin est incorrect. Si votre fichier principal se trouve dans un dossier, par exemple, spécifiez folder/file.py.
La quantité minimale de RAM requise pour héberger un bot est de 256 Mo et pour un site/API de 512 Mo. Cependant, selon la taille et la complexité de votre application, il peut être conseillé d’allouer une plus grande quantité de RAM afin d’éviter que votre application ne manque de mémoire et ne plante.

​
📤 Comment héberger votre projet

Maintenant que vous avez préparé tous les fichiers de votre projet Python, l’étape suivante consiste à les téléverser sur Square Cloud et à mettre votre application en ligne. Il existe plusieurs façons de téléverser, mais nous en aborderons deux : via le Dashboard ou via la CLI.

​
Via le tableau de bord

1

Accéder à la page d'upload

Accédez à la page d’upload et téléversez le fichier zip de votre projet.
2

Configurer votre environnement

Après avoir téléversé votre zip, vous devrez configurer le nom, le fichier principal ou l’environnement d’exécution ainsi que d’autres paramètres de votre projet.
Si vous téléversez un projet web, veillez à sélectionner « Publication Web » et à définir un sous-domaine pour votre projet.
3

Déployer votre projet

Enfin, cliquez sur le bouton « Deploy » pour héberger votre projet sur Square Cloud.
Une fois le déploiement effectué, vous pouvez suivre l’état et les logs de votre projet depuis le tableau de bord.
Téléversement d'une application vers Square Cloud

​
Via la CLI

Pour utiliser cette méthode, vous devez créer un fichier de configuration nommé squarecloud.app à la racine de votre projet. Ce fichier contiendra la configuration nécessaire à votre projet.

En savoir plus : comment créer le fichier de configuration pour Square Cloud.

Le fichier squarecloud.app est un fichier de configuration qui servira à configurer votre application ; il sera utilisé pour définir votre environnement.
1

Installer la CLI

Tout d’abord, vous devez avoir la CLI installée dans votre environnement. Si ce n’est pas encore le cas, exécutez la commande suivante dans votre terminal :
npm install -g @squarecloud/cli
Si vous l’avez déjà, nous vous recommandons de la mettre à jour. Pour cela, exécutez la commande suivante dans votre terminal :
squarecloud update
2

S'authentifier

Maintenant, pour vous authentifier et utiliser les autres commandes de la CLI, vous trouverez votre clé d’autorisation ici en cliquant sur « Request API Key ». Après avoir obtenu votre clé d’autorisation, exécutez la commande suivante :
squarecloud auth login
3

Téléverser votre projet

Enfin, pour déployer votre application sur Square Cloud à l’aide de la CLI, vous devez exécuter la commande suivante :
squarecloud upload
Ou si vous avez créé le zip manuellement, vous pouvez utiliser :
squarecloud upload --file <path/to/zip>

​
Contactez-nous

Si vous rencontrez toujours des difficultés techniques, notre équipe de support spécialisée est disponible pour vous aider. Contactez-nous et nous serons ravis de vous aider à résoudre tout problème.