rize_reader

Риз-читатель

Это сценарий Python Companion для Frize. Он собирает данные из вашей электронной почты и хранит их в базе данных Supabase.

Предварительные условия

Прежде чем начать, убедитесь, что у вас есть следующее:

• Python: сценарий требует, чтобы Python был установлен на вашей машине. Вы можете скачать его с python.org.
• Учетные данные Gmail API: Следуйте инструкциям в Руководстве Gmail API Python QuickStart, чтобы настроить ваш облачный проект Google и получить учетные данные.
• Учетная запись Supabase: Зарегистрируйтесь в учетной записи Supabase для создания базы данных и получения SUPABASE_URL и SUPABASE_API_KEY для API Access.
• OpenAI API -ключ: Получите ключ API от OpenAI, так как мы будем использовать его для генерации внедрения для наших данных.

Установка

1. Клонировать это хранилище на местной машине

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

2. Перейдите к каталогу проекта

    cd rize_reader

3. Создать виртуальную среду

   python3 -m venv venv

4. Установите зависимости

   pip3 install -r requirements.txt

5. Активировать виртуальную среду
   • Для MacOS/Linux:

      source venv/bin/activate

   • Для Windows:

     venv S cripts a ctivate

6. Экспортируйте необходимые переменные среды в вашем терминале

    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

   Примечание. Поместите почтовый адрес, который вы получаете свои Rize Emails от in RIZE_MAIL_ID .
7. Сохраните свои учетные данные Gmail API в том же каталоге, что и main.py и переименовать его в credentials.json .
8. Запустите сценарий

   python3 main.py

9. Вам будет предложено разрешить сценарий для доступа к вашей учетной записи Gmail. Возможно, вам придется добавить redirect_uri на экран согласия OAuth. Вы можете сделать это, добавив необходимый redirect_uri в список авторизованных Redirect URI на экране согласия OAuth в консоли Cloud Google.
10. Сценарий начнет собирать данные по электронной почте и хранить их в базе данных Supabase. Вы можете просмотреть данные на панели панели Supabase.

Примечание. Если вы уже некоторое время использовали Rize, перейдите в свою учетную запись Gmail и найдите Rize и получите общее количество электронных писем. Затем перейдите на main.py и измените значение max_results на общее количество электронных писем, которые у вас есть. Это гарантирует, что скрипт также собирает все ваши предыдущие данные. После того, как сценарий завершит запуск, вы можете изменить значение max_results обратно на 1.

Автоматизация

Вы можете автоматизировать сценарий для регулярных промежутков, используя задание Cron. Я лично запускаю его на облачном сервере, но вы также можете запустить его на своей локальной машине. Чтобы сделать это, следуйте шагам ниже:

1. Откройте свой терминал и введите crontab -e чтобы открыть таблицу Cron.
2. Получите путь к исполнению Python3 в вашей виртуальной среде, запустив which python3 в вашем терминале и скопируйте его.
3. Добавьте следующую строку в таблицу Cron:

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

   Это будет запускать сценарий каждый день в 12:00.
4. Используйте абсолютный путь для файла credentials.json в main.py , так как задания Cron не имеют доступа к текущему рабочему каталогу.

Примечание

• Замените /path/to/rize_reader с помощью каталога RISE_READER и /path/to/venv/bin/python3 с помощью Python3 исполняемого в вашей виртуальной среде.
• Если вы получите ошибку, когда она не может найти переменные среды, то объявите переменные в верхней части таблицы Cron.

Внося

Вклад всегда приветствуются! Не стесняйтесь открывать проблему или отправить запрос на привлечение, если у вас есть какие -либо идеи или предложения.