google-photos-archiver 0.1.7

Archives the contents of your Google Photos library to disk

google-photos-archiver

• What?
• Why?
• How?
• Pre-reqs
  • Development Reqs
• Getting Started
  • Google Oauth Setup
  • First Run
  • Usage
  • ... with Docker
  • Running tests
• Examples
  • Specify a different download location
  • Download from specific dates (with wildcard support)
  • --help
  • archive-media-items --help
  • Download Path Hierarchy

What?

google-photos-archiver aims to provide a simple, fast, extensible interface to be able to back up one's Google Photos to a location of their choosing.

I've drawn inspiration from projects such as: https://github.com/mholt/timeliner & https://github.com/gilesknap/gphotos-sync but wanted to cut my teeth in this domain and see what I could come up with myself.

Why?

I wanted a tool (of my own creation) which could easily provide a copy of mine and my partner's Google Photos libraries, and keep said copy up to date over time.

In reality I've mainly just needed a distraction from the vicious cycle of wake, work, Netflix, sleep, and I thought it was high time to do a little side project.

How?

Pre-reqs

• docker

... Or

• python==3.8
• poetry >=1.0.0

Development Reqs

• pre-commit
  • Run pre-commit install

Getting Started

Google Oauth Setup

These instructions will help you set up Google OAuth2 client credentials so you can start using google-photos-archiver

• While logged into your Google account navigate to Create a New Project
• Create one, and switch to using it with the UI dropdown
• Navigate to APIs & Services click on + Enable APIs and services, and enable the Photos Library API
• Navigate back to APIs & Services and click on Credentials
• Click on + Create Credentials > OAuth client ID
• Configure an OAuth consent screen. You can just fill out the required fields and hit Save.
  • Click Add Or Remove Scopes and manually add scope: https://www.googleapis.com/auth/photoslibrary.readonly
  • Accept remaining defaults, save through and return to Credentials
• Click on + Create Credentials > OAuth client ID
• Make a "Desktop App"
• Congrats!, you now have a Client ID and Client Secret
• Download the associated client_secret.json file and make note of its location as we'll be providing it's path to google-photos-archiver

First Run

A browser window will be opened during the initial OAuth flow. After successfully authenticating once, a refresh token will be stored for future use (See: --refresh-token-path) and will omit the need to reauthenticate.

Usage

$ git clone [e-mail]:scottx611x/google-photos-archiver.git
$ poetry install
$ poetry run google-photos-archiver --help

... with Docker

Note that some more Docker volume mounting will be warranted here if you want to specify a different path to download to etc. Ref: https://docs.docker.com/storage/volumes

$ docker build . -t google-photos-archiver
$ docker run -v $PWD:/app/ google-photos-archiver  --help

Running tests

$ poetry run pytest

Examples

Specify a different download location

$ poetry run google-photos-archiver archive-media-items --download-path /Volumes/my-big-hdd/downloaded_media

Download from specific dates (with wildcard support)

$ poetry run google-photos-archiver archive-media-items --date-filter 2020/*/*,2021/8/22
$ poetry run google-photos-archiver archive-media-items --date-range-filter 2019/8/22-2020/8/22

--help

Usage: google-photos-archiver [OPTIONS] COMMAND [ARGS]...

Options:
  --client-secret-json-path TEXT  `client_secret.json` file acquired from http
                                  s://developers.google.com/photos/library/gui
                                  des/get-started#request-id  [default:
                                  ./client_secret.json; required]

  --refresh-token-path TEXT       [default: ./refresh_token]
  --help                          Show this message and exit.

Commands:
  archive-media-items

archive-media-items --help

Usage: google-photos-archiver archive-media-items [OPTIONS]

Options:
  --download-path TEXT            Directory that MediaItems will be archived
                                  to  [default: ./downloaded_media]

  --sqlite-db-path TEXT           [default: ./media_items.db]
  --max-threadpool-workers INTEGER
                                  The maximum amount of workers to utilize for
                                  the ThreadPoolExecutor  [default: 100]

  --max-media-items INTEGER       The maximum amount of MediaItems to account
                                  for and archive in a given execution
                                  [default: 200]

  --date-filter TEXT              Up to 5 comma delimited Dates conforming to
                                  the YYYY/MM/DD pattern. Any of YYYY/MM/DD
                                  can be wildcarded (*) like so:
                                  */MM/DD,YYYY/*/DD,YYYY/MM/*

  --date-range-filter TEXT        Up to 5 comma delimited DateRanges
                                  conforming to the YYYY/MM/DD-YYYY/MM/DD
                                  (<start_date>-<end_date>) pattern.

  --help                          Show this message and exit.

Download Path Hierarchy

$ tree /<download_path>/downloaded_media/ | head
/Volumes/2TB/google-photos/scott/downloaded_media/
├── 2021
│ └── 1
│     ├── 1
│     │ └── a.jpg
│     └── 2
│         └── b.mov
├── 2020
│ ├── 1
│ │ └── 2
│ │     └── c.jpg
│ └── 2
│     └── 3
│         └── d.jpg
...