git-annex/doc/tips/flickrannex.mdwn

51 lines
1.7 KiB
Text
Raw Normal View History

2014-01-10 14:33:01 +00:00
flickrannex
=========
2013-05-22 21:26:19 +00:00
2014-01-10 14:33:01 +00:00
Hook program for gitannex to use flickr as backend
2013-05-22 20:42:13 +00:00
# Requirements:
python2
2014-01-10 14:33:01 +00:00
Credit for the flickr api interface goes to: http://stuvel.eu/flickrapi
Credit for the png library goes to: https://github.com/drj11/pypng
Credit for the png tEXt patch goes to: https://code.google.com/p/pypng/issues/detail?id=65
2013-05-22 20:42:13 +00:00
2013-09-11 20:33:09 +00:00
# Install
2013-05-22 20:42:13 +00:00
Clone the git repository in your home folder.
git clone git://github.com/TobiasTheViking/flickrannex.git
This should make a ~/flickrannex folder
2013-09-11 20:33:09 +00:00
# Setup
2014-01-10 14:33:01 +00:00
Make the file executable, and link it into PATH
2013-05-22 21:26:19 +00:00
2014-01-10 14:33:01 +00:00
cd ~/flickrannex; chmod +x git-annex-remote-flickr; sudo ln -sf `pwd`/git-annex-remote-flickr /usr/local/bin/git-annex-remote-flickr
2013-05-22 20:42:13 +00:00
2014-01-10 14:33:01 +00:00
# Commands for gitannex:
2013-05-22 20:42:13 +00:00
2014-01-10 14:33:01 +00:00
USERNAME="username@provider.com" git annex initremote flickr type=external externaltype=flickr encryption=shared folder=gitannex
2013-05-22 20:42:13 +00:00
2014-01-10 14:33:01 +00:00
An oauth authentication link should now be launched in the default browser. The hook will wait for 30s for you to login and authenticate.
2013-05-22 23:10:23 +00:00
2014-01-10 14:33:01 +00:00
git annex describe dropbox "the flickr library"
2013-05-22 23:10:23 +00:00
2013-09-11 20:33:09 +00:00
# Notes
2013-05-22 21:26:19 +00:00
2013-09-11 20:33:09 +00:00
## Unencrypted mode
2013-09-11 20:33:58 +00:00
The photo name on flickr is currently the GPGHMACSHA1 version.
2013-05-22 22:33:29 +00:00
2013-09-11 20:33:09 +00:00
## Encrypted mode
2013-09-11 20:33:58 +00:00
The current version base64 encodes all the data, which results in ~35% larger filesize.
2013-05-22 20:42:13 +00:00
2013-09-11 20:33:58 +00:00
## Including directories as tags
2014-01-10 14:33:01 +00:00
This feature is currently disabled, if it gets implemented again it will most likely not require user action to enable it.
2013-09-11 20:33:58 +00:00
In this case the image:
/home/me/annex-photos/holidays/2013/Greenland/img001.jpg
would get the following tags: "holidays" "2013" "Greenland"
(assuming "/home/me/annex-photos" is the top level in the annex...)
Caveat Emptor - Tags will *always* be NULL for indirect repos - we don't (easily) know the human-readable file name.