rize_reader

lecteur de rize

Ceci est le script Python compagnon pour Frize. Il collecte des données de votre e-mail et les stocke dans une base de données Supabase.

Condition préalable

Avant de commencer, assurez-vous d'avoir ce qui suit:

• Python: le script nécessite que Python soit installé sur votre machine. Vous pouvez le télécharger à partir de python.org.
• Informations d'identification de l'API Gmail: Suivez les instructions du guide QuickStart Gmail API Python pour configurer votre projet Google Cloud et obtenir les informations d'identification.
• Compte Supabase: Inscrivez-vous à un compte Supabase pour créer une base de données et obtenez le SUPABASE_URL et SUPABASE_API_KEY pour l'accès à l'API.
• Clé API OpenAI: Obtenez une clé API à partir d'OpenAI, car nous l'utiliserons pour générer des intégres pour nos données.

Installation

1. Clone ce référentiel sur votre machine locale

   git clone https://github.com/rittikbasu/rize_reader.git

2. Accédez à l'annuaire du projet

    cd rize_reader

3. Créer un environnement virtuel

   python3 -m venv venv

4. Installer les dépendances

   pip3 install -r requirements.txt

5. Activer l'environnement virtuel
   • pour macOS / Linux:

      source venv/bin/activate

   • Pour Windows:

     venv S cripts a ctivate

6. Exporter les variables d'environnement requises dans votre terminal

    export SUPABASE_URL=YOUR_SUPABASE_URL SUPABASE_API_KEY=YOUR_SUPABASE_API_KEY OPENAI_API_KEY=YOUR_OPENAI_API_KEY RIZE_MAIL_ID=YOUR_RIZE_MAIL_ID

   Remarque: Mettez l'adresse courante dont vous recevez vos e-mails Rize dans RIZE_MAIL_ID .
7. Enregistrez vos informations d'identification GMAIL API dans le même répertoire que main.py et renommez-le à credentials.json .
8. Exécutez le script

   python3 main.py

9. Vous serez invité à autoriser le script à accéder à votre compte Gmail. Vous devrez peut-être ajouter un redirect_uri sur votre écran de consentement OAuth. Vous pouvez le faire en ajoutant le redirect_uri requis vers la liste des URI de redirection autorisés dans l'écran de consentement OAuth dans la console Google Cloud.
10. Le script commencera à collecter des données à partir de votre e-mail et à les stocker dans votre base de données Supabase. Vous pouvez afficher les données de votre tableau de bord Supabase.

Remarque: Si vous utilisez déjà Rize depuis un certain temps, rendez-vous sur votre compte Gmail et recherchez Rize et obtenez le nombre total d'e-mails. Allez ensuite sur main.py et modifiez la valeur de max_results au nombre total d'e-mails que vous avez. Cela garantira que le script collecte également toutes vos données précédentes. Une fois le script terminé en cours d'exécution, vous pouvez modifier la valeur de max_results à 1.

Automation

Vous pouvez automatiser le script pour s'exécuter à intervalles réguliers à l'aide d'un travail Cron. Je l'exécute personnellement sur un serveur cloud, mais vous pouvez également l'exécuter sur votre machine locale. Pour ce faire, suivez les étapes ci-dessous:

1. Ouvrez votre terminal et tapez crontab -e pour ouvrir la table cron.
2. Obtenez le chemin de l'exécutable Python3 dans votre environnement virtuel en exécutant which python3 dans votre terminal et copiez-le.
3. Ajoutez la ligne suivante à la table Cron:

    00 00 * * * /path/to/venv/bin/python3 /path/to/rize_reader/main.py

   Cela exécutera le script tous les jours à 12h00.
4. Utilisez un chemin absolu pour le fichier de credentials.json dans main.py car les travaux CRON n'ont pas accès au répertoire de travail actuel.

Note

• Remplacez /path/to/rize_reader par le chemin du répertoire Rize_reader et /path/to/venv/bin/python3 par le chemin d'accès à l'exécutable Python3 dans votre environnement virtuel.
• Si vous obtenez une erreur où il ne peut pas trouver les variables d'environnement, déclarez les variables en haut de la table cron.

Contributif

Les contributions sont toujours les bienvenues! N'hésitez pas à ouvrir un problème ou à soumettre une demande de traction si vous avez des idées ou des suggestions.