rize_reader

Rize-Reader

Ini adalah skrip Python pendamping untuk Frize. Ini mengumpulkan data dari email Anda dan menyimpannya di database Supabase.

Prasyarat

Sebelum Anda mulai, pastikan Anda memiliki yang berikut:

• Python: Skrip membutuhkan python untuk diinstal pada mesin Anda. Anda dapat mengunduhnya dari python.org.
• Kredensial API Gmail: Ikuti instruksi dalam panduan GMAIL API Python QuickStart untuk mengatur proyek Google Cloud Anda dan mendapatkan kredensial.
• Akun Supabase: Mendaftar untuk akun Supabase untuk membuat database dan mendapatkan SUPABASE_URL dan SUPABASE_API_KEY untuk akses API.
• Kunci API OpenAI: Dapatkan kunci API dari OpenAi karena kami akan menggunakannya untuk menghasilkan embeddings untuk data kami.

Instalasi

1. Klon Repositori ini di mesin lokal Anda

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

2. Arahkan ke Direktori Proyek

    cd rize_reader

3. Buat lingkungan virtual

   python3 -m venv venv

4. Instal dependensi

   pip3 install -r requirements.txt

5. Aktifkan lingkungan virtual
   • Untuk MacOS/Linux:

      source venv/bin/activate

   • untuk windows:

     venv S cripts a ctivate

6. Ekspor variabel lingkungan yang diperlukan di terminal Anda

    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

   CATATAN: Letakkan alamat surat yang Anda terima email Rize Anda dari in RIZE_MAIL_ID .
7. Simpan kredensial API Gmail Anda di direktori yang sama dengan main.py dan ganti namanya menjadi credentials.json .
8. Jalankan skrip

   python3 main.py

9. Anda akan diminta untuk mengotorisasi skrip untuk mengakses akun Gmail Anda. Anda mungkin perlu menambahkan redirect_uri ke layar persetujuan OAuth Anda. Anda dapat melakukan ini dengan menambahkan Redirect_uri yang diperlukan ke daftar URI Redirect Resmi di layar OAuth Consent di Google Cloud Console.
10. Skrip akan mulai mengumpulkan data dari email Anda dan menyimpannya di database Supabase Anda. Anda dapat melihat data di dasbor Supabase Anda.

Catatan: Jika Anda sudah menggunakan Rize untuk sementara waktu maka buka akun Gmail Anda dan cari Rize dan dapatkan jumlah total email. Kemudian pergi ke main.py dan ubah nilai max_results ke jumlah total email yang Anda miliki. Ini akan memastikan bahwa skrip mengumpulkan semua data Anda sebelumnya juga. Setelah skrip selesai berjalan, Anda dapat mengubah nilai max_results kembali ke 1.

Otomatisasi

Anda dapat mengotomatiskan skrip untuk berjalan secara berkala menggunakan pekerjaan cron. Saya pribadi menjalankannya di server cloud tetapi Anda juga dapat menjalankannya di mesin lokal Anda. Untuk melakukan ini, ikuti langkah -langkah di bawah ini:

1. Buka terminal Anda dan ketik crontab -e untuk membuka tabel cron.
2. Dapatkan jalur ke Python3 yang dapat dieksekusi di lingkungan virtual Anda dengan menjalankan which python3 di terminal Anda dan salin.
3. Tambahkan baris berikut ke tabel cron:

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

   Ini akan menjalankan skrip setiap hari pukul 12:00 pagi.
4. Gunakan jalur absolut untuk file credentials.json di main.py karena pekerjaan cron tidak memiliki akses ke direktori kerja saat ini.

Catatan

• Ganti /path/to/rize_reader dengan jalur ke direktori rize_reader dan /path/to/venv/bin/python3 dengan jalur ke python3 yang dapat dieksekusi di lingkungan virtual Anda.
• Jika Anda mendapatkan kesalahan di mana ia tidak dapat menemukan variabel lingkungan maka nyatakan variabel di bagian atas tabel cron.

Berkontribusi

Kontribusi selalu diterima! Jangan ragu untuk membuka masalah atau mengirimkan permintaan tarik jika Anda memiliki ide atau saran.