flickrbackup 0.12.6
Flickr backup utility
License: BSD
Keywords: flickr backup

Flickr Incremental Backup
=========================

A tool to incrementally backup your photos from `Flickr <http://flickr.com>`_.

Installation
-------------

Requires Python 3 and `pip`.

    $ pip install flickrbackup

For the web session authentication feature (see below, you'll also need
Selenium and a compatible web driver (Chrome or Firefox)::

    $ pip install selenium

Make sure you have Chrome/Chromium or Firefox installed, as these are used
for capturing authenticated sessions.

Usage
-----

Note: You must have a Flickr Pro account to use this tool, since Flickr only
allows access to original-scale images for Pro members.

The first time you run flickrbackup, you should specify a start date, using the
format ``YYYY-MM-DD``::

    $ flickrbackup.py -f 2012-02-28 photos

This will ask you to visit a URL to authorize flickrbackup with your
Flickr account, if you haven't already. You will then be given a short token
by Flickr, which you must type into the console. This token is saved for future
use so you shouldn't need any manual intervention again, unless you or Flickr
revoke the token.

Once authorised, flickrbackup will download all photos and videos for the
authorised account that have been created or updated on or after the "from" date
(February 28th, 2012 in this case) into the directory specified (``photos`` in
this case). Items are organised into subfolders by set and the year, month and
day they were taken. If an item appears in multiple sets, it will be copied into
both set directories. Metadata such as the title, description, tags and other
information will be placed in a file with a ``.txt`` extension next to the image
file. The image file name is based on the Flickr id of the image.

After the first successful run, a special file named ``.stamp`` will be placed
in the download directory, containing the date of the last backup. This allows
flickrbackup to be run again without the ``-f`` argument, for example in a
scheduled nightly "cron" job, picking up from where it left off::

    $ flickrbackup.py /path/to/photos

Here, we have also omitted the "-v" (verbose) flag, which means only errors and
important messages are output to the console, as well as a log of the ids of the
photos that have been processed (mostly as a progress indicator).

It may be useful to log important messages to a file. In this case, use the
``--log-file`` (``-l``) option (with or without the ``-v`` flag to control the
amount of information output)::

    $ flickrbackup.py -l /var/log/flickrbackup.log /path/to/photos

The log file will contain the type of message (e.g. ``INFO`` for informational
messages or ``WARN`` for warnings) and the date and time of the message as well.

What if there are errors, e.g. due to a temporary conneciton problem?
flickrbackup will attempt to download them again (you can control how many times
or turn this off using the ``--retry`` option; the default is to retry once),
but if there are still errors they will be printed to the console/log file.

We can store a list of the ids of the photos and videos that were not correctly
processed by using the ``--error-file`` (``-e``) flag::

    $ flickrbackup.py -e /path/to/photos/errors.txt /path/to/photos

Later, we can attempt to manually re-process just these photos using the
``--download`` (``-d``) option::

    $ flickrbackup.py --download /path/to/photos/errors.txt /path/to/photos

If this succeeds, you should delete ``errors.txt``, since the ``-e`` option
will always append to, not replace, this file.

As of version 0.10 it is also possible to download the authenticated user'
favorite photos (which could be uploaded by another user). In this case,
files are always organised by date and not set::

    $ flickrbackup.py --favorites /path/to/faves

Web Session Authentication
~~~~~~~~~~~~~~~~~~~~~~~~~~

Some photos and videos on Flickr may require additional authentication beyond
the API token. It is a little unclear why this happens, but it seems to relate
to videos, especially ones uploaded some time ago. It is possible that this is
an unresolved issue with the way Flickr manages its media files in CDNs, but
there is no official support channel for the API so we have to make some guesses.

As of version 0.11, flickrbackup will notice when this happens and log a
warning. As of version 0.12, there is support to identify the relevant missing
files in a large download directly to make it easier to attempt to re-download
them (see below).

To make a redownload attempt more likely to work, flickrbackup supports using
authenticated browser session data. This requires a manual log-in via a web
browser (Chrome or Firefox), but for as long as this session remains valid,
(a Flickr policy) it should then work without a browser (and potentially on
a different machine, which means it is possible to performt the authentication
on a desktop and copy the session file to a NAS or server that is performing
regular backups).

First, capture an authenticated session by launching a browser and logging in::

    $ flickrbackup.py --obtain-web-session session.json

This will open a browser window to Flickr's login page. Log in to your account,
then press Enter in the console. The session data (including cookies) will be
saved to ``session.json``.

**Note:** This will only work in a windowed environment e.g. MacOS, Windows or
a Linux desktop.

**WARNING:** The session file contains sensitive authentication data, so it
should be kept secure. Saving this data in plain text is not really great
security practice, but there are few good generic options that would not make
this script significantly more complicated to deploy and use. However, you are
recommended to set file permissions so that only the user who will be running
the script can read it, e.g.::

    $ chmod 600 session.json

You can then use this session data for downloads::

    $ flickrbackup.py --web-session session.json <other options as needed> /path/to/photos

By default, Chrome is used for session capture, but you can specify Firefox::

    $ flickrbackup.py --obtain-web-session session.json --browser firefox

Finding Missing Files
~~~~~~~~~~~~~~~~~~~~~

If you suspect some media files failed to download but have metadata files,
you can find them using::

    $ flickrbackup.py --find-missing missing.csv /path/to/photos

This will search for ``.txt`` metadata files that don't have corresponding
media files and output a CSV file with photo IDs, URLs, and directories.
You can then use this information to retry downloads or investigate issues.

If you want to specifically download these files, you can copy the first
column of the CSV file to a text file and use it with the
``--download`` option. To do this on the command line::

    $ cut -d',' -f1 missing.csv > redownload_missing.txt
    $ flickrbackup.py --download redownload_missing.txt --web-session session.json /path/to/photos

In this example, we have also used the ``--web-session`` option to make it more
likely to work (see above). There is no particular reason you can't pass
`--web-session` to the script every time you run it, though it might be difficult to
detect if and when the session is no longer valid. The return of unexpected 404 errors
might be a good indication. In this case, authenticate again as above and replace the
session file.

If you are using the ``--favorites`` mode and have failed downloads
(saved via ``--error-file``), you can retry them while preserving the favorites behavior
by combining ``--download`` and ``--favorites``::

    $ flickrbackup.py --download errors.txt --favorites /path/to/photos

This ensures that retried downloads behave consistently with the original favorites
backup (no set directories, store-once behavior).

Known limitations
-----------------

* Movie files will always get the extension ``.mov``, even if originally
  uploaded as e.g. ``.avi`` or ``.mpg``, because Flickr doesn't provide a
  means of discovering the original file extension.
* Photos that are deleted or moved between sets after being backed up will
  remain in the backup.

Logging out
-----------

OAuth tokens are stored in a database in `~/.flickr/oauth-tokens.sqlite`. If
you need to, you can delete this file to force re-authorization. You can also
use the ``--token-cache`` option to specify a different location for this database,
including an empty directory, which will again force re-authentication.

Changelog
---------

Version 0.12.6, released 2025-07-23
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix an error with --keep mode

Version 0.12.5, released 2025-07-20
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix retry logic even when there is an early Flickr error.

Version 0.12.4, released 2025-07-20
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Added support for combining ``--favorites`` and ``--download`` options to ensure consistent
  behavior when retrying failed favorites downloads. When both flags are used together,
  the download mode will behave like favorites mode (no set directories, store-once behavior).

Version 0.12.3, released 2025-07-17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Be more careful with error codes when failing due to invalid parameters

Version 0.12.2, released 2025-07-17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix a bug where the start date was not being set correctly when running
  the script without a ``--from-date`` argument in favourites mode

Version 0.12.1, released 2025-07-17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Avoid the need to specify the photos directory when using ``--obtain-web-session``

Version 0.12, released 2025-07-17
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Added web session support for authenticated downloads to help with photos/videos that require browser authentication
* Added ``--obtain-web-session`` option to capture authenticated browser session data
* Added ``--web-session`` option to use captured session data for downloads
* Added ``--find-missing`` option to identify missing media files (which may require)
  a web session to work
* Modernized HTTP operations by replacing ``urllib`` with ``requests`` library
* Enhanced cookie handling for better authentication support

Version 0.11.3, released 2025-07-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Write the download url to the metadata file, to make it easier to manually
  download files that flickrbackup could not download (e.g. due to a 404 error)
* Save metadata files even if the download fails with a 404 error. This, plus
  logging that indicates when this happens, should make it possible to manually
  download videos that Flickr refuses to let the script download.

Version 0.11.2, released 2025-07-14
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix a typo in an error message

Version 0.11.1, released 2025-07-14
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Return exit status 2 if the script completed but some items had errors
  (status 1 will still mean an unexpected error occurred)

Version 0.11, released 2025-07-13
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix video image download issue (see below)
* Improve logging of errors when Flickr flat out refuses to let you download a video

**NOTICE**: It is likely that previous versions of ``flickrbackup`` incorrectly
downloaded videos as images. That is, the ``.mov`` file might contain an image
(a thumbnail) rather than the video itself. This has now been fixed, but you
may need to re-download the affected videos. If you have a lot of files, this
could be tricky. The following Bash shell commands can help you identify which
images are suspicious:

.. code-block:: bash

  # Go to the root of the directory where flickrbackup will have downloaded its files
  $ cd /backups/directory

  # Run the following command from this directory, all in one go
  $ find . -type f -name "*.mov" | while read -r filepath; do
    mimetype=$(file --mime-type -b "$filepath")
    if [[ "$mimetype" != video/* ]]; then
      id=$(basename "$filepath" .mov)
      size=$(du -h "$filepath" | cut -f1)
      echo "$id,$filepath,$size"
    fi
  done | tee movie_files.csv

  # This will create a file named `movie_files.csv` in the current directory
  # that shows files, path, and sizes of videos with the wrong MIME type.
  
  # If you want to re-download all these files, do the following:
  $ cat movie_files.csv | cut -d',' -f1 > redownload_movies.txt
  $ flickrbackup.py --download redownload_movies.txt <other options> .

Please make sure the ``file`` utility is installed on your system.

Version 0.10.3, released 2025-07-11
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Make the downloader more resilient to missing files
* Add new `--single-threaded` option to disable threading for easier debugging
* Fix a defect whereby "download" mode would not correctly use the `--token-cache` option

Version 0.9.1, released 2019-08-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Make metadata files use UTF-8 by default

Version 0.9.0, released 2019-08-15
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Migrate to Python 3 and new `flickrapi` library
* Make use of new command line solution for getting the auth token, thereby
  making it easier to run on a remote server.

Version 0.8.4, released 2019-01-08
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix README to stop referring to a defunct website in the installation instructions

Version 0.8.3, released 2018-10-03
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fix encoding error with set names


Version 0.8.2, released 2013-07-29
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Attempt to fix missing README.rst issue in tarball

Version 0.8.1, released 2013-06-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Fixed potential issue with copying directories to sets they are already in

Version 0.7, released 2013-01-01
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Added ``--log-file`` option
* Added ``-download`` option
* Added ``--retry`` and ``--error-file`` options

Version 0.6, released 2012-12-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Exit with a nonzero return code on failure

Version 0.5, released 2012-12-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Allow set names with characters that are not valid directory names
* Print erroneous items at the end of the run

Version 0.4, released 2012-12-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* In non-verbose mode, print photo id instead of just "." for each completed
  download.

Version 0.3, released 2012-12-31
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

* Added ``--store-once`` and ``--keep-existing`` options
* Removed ``--username`` option - you must authenticate as the user to use