rize_reader

lector de rize

Este es el guión compañero de Python para Frize. Recopila datos de su correo electrónico y los almacena en una base de datos Supabase.

Requisitos previos

Antes de comenzar, asegúrese de tener lo siguiente:

• Python: El script requiere que Python se instale en su máquina. Puede descargarlo de python.org.
• Credenciales de la API de Gmail: siga las instrucciones en la Guía Gmail API Python QuickStart para configurar su proyecto de Google Cloud y obtener las credenciales.
• Cuenta de Supabase: Regístrese para obtener una cuenta de Supabase para crear una base de datos y obtener el SUPABASE_URL y SUPABASE_API_KEY para el acceso a la API.
• Clave de API de OpenAI: obtenga una clave API de OpenAI, ya que la usaremos para generar incrustaciones para nuestros datos.

Instalación

1. Clon este repositorio en su máquina local

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

2. Navegue al directorio del proyecto

    cd rize_reader

3. Crear un entorno virtual

   python3 -m venv venv

4. Instalar las dependencias

   pip3 install -r requirements.txt

5. Activar el entorno virtual
   • para macOS/Linux:

      source venv/bin/activate

   • Para Windows:

     venv S cripts a ctivate

6. Exportar las variables de entorno requeridas en su 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

   Nota: Ponga la dirección de correo que recibe sus correos electrónicos de Rize en RIZE_MAIL_ID .
7. Guarde sus credenciales de API de Gmail en el mismo directorio que main.py y cambie el nombre a credentials.json .
8. Ejecutar el guión

   python3 main.py

9. Se le pedirá que autorice el script para acceder a su cuenta de Gmail. Es posible que deba agregar un redirect_uri a su pantalla de consentimiento OAuth. Puede hacer esto agregando el Redirect_URI requerido a la lista de URI de redirección autorizados en la pantalla de consentimiento de OAuth en la consola de Google Cloud.
10. El script comenzará a recopilar datos de su correo electrónico y almacenarlos en su base de datos Supabase. Puede ver los datos en su tablero de Supabase.

Nota: Si ya ha estado usando Rize por un tiempo, vaya a su cuenta de Gmail y busque Rize y obtenga el número total de correos electrónicos. Luego vaya a main.py y cambie el valor de max_results al número total de correos electrónicos que tiene. Esto asegurará que el script recopile todos sus datos anteriores también. Una vez que el script ha terminado de ejecutarse, puede cambiar el valor de max_results de regreso a 1.

Automatización

Puede automatizar el script para ejecutarse a intervalos regulares utilizando un trabajo cron. Personalmente lo ejecuto en un servidor en la nube, pero también puede ejecutarlo en su máquina local. Para hacer esto, siga los pasos a continuación:

1. Abra su terminal y escriba crontab -e para abrir la mesa cron.
2. Obtenga el camino hacia el ejecutable de Python3 en su entorno virtual ejecutando which python3 en su terminal y copiarlo.
3. Agregue la siguiente línea a la tabla cron:

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

   Esto ejecutará el guión todos los días a las 12:00 a.m.
4. Use una ruta absoluta para el archivo credentials.json en main.py ya que los trabajos cron no tienen acceso al directorio de trabajo actual.

Nota

• Reemplace /path/to/rize_reader con la ruta al directorio rize_reader y /path/to/venv/bin/python3 con la ruta al ejecutable Python3 en su entorno virtual.
• Si recibe un error en el que no puede encontrar las variables de entorno, declare las variables en la parte superior de la tabla cron.

Que contribuye

¡Las contribuciones siempre son bienvenidas! Siéntase libre de abrir un problema o enviar una solicitud de extracción si tiene alguna idea o sugerencia.