gfetch 0.1.6

A CLI app to back up your gmail emails locally

gfetch-cli - save gmail emails locally

The CLI version of gfetch-web!

This app helps you create local backups of your Gmail emails. It saves raw .eml files, cleaned .txt files, and attachments, each to their own directory.

It is built using Python and the Gmail API.

[!NOTE] The following instructions assume you are using uv.

Running Gfetch without installation

uvx gfetch

[!NOTE] You will not be able to download emails without a valid credentials.json file (see Setting up Google Cloud).

[!WARNING] Invoking gfetch in this way will create a directory called gfetch and its subdirectories in your current working directory!

Installation for local development

Clone this repository:

git clone [e-mail]:jwjacobson/gfetch-cli.git

Navigate to the gfetch-cli directory:

cd gfetch-cli

Install dependencies:

uv sync

Create a .env file from the provided template:

cp env-template .env

If you use the default values from env-template, the project layout will be as follows:

src
└── gfetch
    ├── cleaned_emails
    │   └── attachments
    ├── raw_emails
    ├── credentials.json
    └── token.json
    (.py files omitted for clarity)

[!NOTE]

• The cleaned_emails, raw_emails, and attachments directories are not part of the repo, but will be created when you run the app.
• You have to manually download credentials.json (see Setting up Google Cloud below); token.json will be generated automatically when you authenticate with the app.

[!WARNING] credentials.json contains sensitive data and should not be put in version control. It is already listed in .gitignore but might not be covered if you change the filename.

Setting up Google Cloud

For now, Gfetch requires you to create your own credentials to use it.

1. Go to the Google Cloud Console and create an account if you don't have one
2. Using the navigation menu in the top-left of the screen, go to APIs & Services, then Enable APIs and Services
3. Search gmail in the box and find the Gmail API, then enable it
4. In the APIs & Services menu, click Credentials, then click Create Credentials, then OAuth Client ID
5. For application type, select Desktop App and name it how you desire -- perhaps gfetch?
6. Follow the prompts to generate credentials
7. Once you've created the credentials, must download them immediately, as you won't be able to access them again once you've left the confirmation screen. Download the credentials JSON and save it as credentials.json in src/gfetch/

Running gfetch after local installation

uv run gfetch

Or, if you have Just installed:

just run

Follow the onscreen instructions to back up your emails!

[!NOTE] At present, Gfetch only allows you to download all correspondence with a given address.

If you don't have a valid token, your default browser will open for you to authenticate with the account of your choice when you enter a correspondent's email. You will also have to grant access to Gfetch in order to download your emails. I promise I'm not doing anything with them! (terms of service to be published soon)

License

Gfetch is free software, released under version 3.0 of the GPL. Everyone has the right to use, modify, and distribute gfetch subject to the stipulations of that license.