GitHunt
HI

himynameisjonas/gkeep-matlistan

Sync Google Keep with the Matlistan app

gkeep-matlistan-sync

This project is designed to synchronize items from Google Keep to Matlistan. The synchronization process retrieves all unchecked items from a specified Google Keep note and adds them to the designated Matlistan list. By default, the synchronization runs every 45 minutes.

Prerequisites

Make sure you have the following installed before running the project:

  • Docker
  • Docker Compose

Getting Started

  1. Create a docker-compose.yml file and copy the contents of the docker-compose.yml file into it.

  2. Create a file named .env in the root directory and provide the necessary environment variables. The required variables are:

    • MATLISTAN_EMAIL: The email address associated with your Matlistan account.
    • MATLISTAN_PASSWORD: The password for your Matlistan account.
    • MATLISTAN_LIST_ID: The ID of the Matlistan list where the items will be added.
    • GOOGLE_EMAIL: The email address associated with your Google account.
    • GOOGLE_PASSWORD: The password for your Google account.
    • KEEP_LIST_ID: The ID of the Google Keep note where the items will be retrieved from.

    Optionally, you can also provide the following variables:

    • SYNC_INTERVAL: The number of minutes between each synchronization. The default value is 45.
    • SUCCESS_WEBHOOK_URL: A webhook URL that will be called when the synchronization is successful. The default value is "".
  3. Run the Docker container using Docker Compose:

    docker-compose up -d
    

    This will build the Docker image and start the synchronization process.

  4. The synchronization process will run once immediately and then continue to run every 45 minutes.

Persistence

  • The state of the Google Keep notes and the authentication token are stored in the /data directory within the container. This directory is mapped to the ./data directory on the host machine.

Languages

Python94.3%Dockerfile5.7%

Contributors

Created January 9, 2024
Updated January 11, 2024
himynameisjonas/gkeep-matlistan | GitHunt