view README.md @ 11:6c5157c1027b

Describe how to acquire the client secret for photosync to work.
author Lewin Bormann <lbo@spheniscida.de>
date Fri, 14 Jun 2019 23:01:59 +0200
parents d29a31694736
children 53e94b301d31
line wrap: on
line source

# photosync

Now that Google deprecated the Photos<-\>Drive synchronization, I need another way to back up my photos locally. This
program downloads all photos from your Google Photos account and organizes them locally. It is not very user friendly
yet, but definitely usable.

photosync only ever downloads photos, i.e. the synchronization works from Google Photos as Source of Truth to your local
storage. Don't worry about deleting photos locally; although you have to use the slow `--resync` option (note: not yet
implemented :) to re-download them.

**Pull requests are welcome!**

## Behavior

By default, photosync will ask for OAuth2 authorization on the console, and then immediately start downloading metadata
from Google Photos. Once no more new photos are fetched and all metadata is stored in `sync.db`, photosync will look for
photos that are not yet marked as downloaded in the database and fetch the actual image files. By default, it will
organize photos in directories like `year/month/day/` (numerically, 0-padded), but you can write your own method of
mapping photos to directories and override it by setting the `path_mapper` argument in the `Driver` constructor called
from `Main.main()`.

Note that this (obviously) takes a while for large libraries. But you can always stop photosync and restart it later;
without the `--all` option, it will resume synchronization where it left off.

Albums are currently ignored. Videos are downloaded just like photos.

## Install & Use

First, acquire a client secret. This is necessary because this is an open source project, and I don't want client
credentials associated with my account floating around in the wild. Also, the daily limit for Photos API calls is at
10'000, so it wouldn't work for a nontrivial number of users anyway.

For this,

1. go to https://console.developers.google.com.
1. Go to the APIs page and enable the Google Photos API.
1. Set up the OAuth consent screen (otherwise Google will nag you during credentials creation to do it).
1. Then go to the *Credentials* page and create a new client ID (type `other`). Download the JSON file using the
   download button at the right hand side.
1. Save the downloaded JSON file and put it somewhere, for example in your photos directory. Pass the path to the file
   to photosync using the `--creds` argument. By default, photosync will look for a file called `clientsecret.json` in
   the current directory.

Once you have gone through the hassle of obtaining the client secret, you can start downloading your photos.

1. Clone this repository to a convenient place: `git clone https://github.com/dermesser/photosync` or `hg clone
   git+https://github.com/dermesser/photosync`.
1. Install `pipenv`: `pip3 install pipenv` if not yet installed.
1. Go into the `photosync` repository and run `pipenv install` (make sure that `~/.local/bin/pipenv` is in your `PATH`)
1. Activate the virtualenv: `pipenv shell` (sigh)
1. Run it: `python3 photosync.py --help`

Consult the help text printed by the last command. Usually you will need to set `--dir` so that your photos don't end up
in the repository.