Running py2FaceR
===================

.. _running-workflow:

Workflow
--------

Syncing facial data from Picasa to flickr depends on several bits of information
 * Your contacts from Picasa (contacts.xml)
 * The recognized faces in an image (.picasa.ini)
 * The image (some jpg, which has already been uploaded to flickr in your 
   account)

Thus running py2FaceR loosely depends on a particular image work-flow. 
The one I've been using is:

 #. Get the raw data from the camera
 #. Edit / Clean / Rename the photos and place those cleaned photos in a 
    separate folder
 #. Have Picasa go through those cleaned photos and do it's facial recognition 
    on the edited photos. Edit the faces in picasa if needed.
 #. Upload the photos to flickr (I actually use the the flickr uploadr for this)
 #. Run py2FaceR (see :ref:`running-cli`)

.. _running-config:

Config File
-------------------------

This area of the docs will be filled in later. For now the template config
file supplied with the code should have enough detail to get started. Please
file a bug report if it is not =)

DEFAULT - db_url - sqlite:///filename
CONTACTS - contacts_path (used?)

py2FaceR depends on a sqlite database but should in theory work with any 
database supported by SQLAlchemy.

.. _running-cli:

Running from the command line
-----------------------------

py2FaceR needs to link your Google contacts to your flickr contacts. Thus the
command::

    py2FaceR.py sync-contacts -c config.conf

.. note:: The linking is based on the e-mail address. Thus if you have
          bob@gmail.com but he's using bob@yahoo.com for his flickr contact
          e-mail then he won't be linked. To make it work your Google contact 
          needs to have the e-mail address they registered with flickr. 
          py2FaceR will try every e-mail address you have for a contact until
          it either finds them or runs out of addresses.

Once the mapping of Google contacts to flickr contacts is complete then it's
possible to push some facial data::
 
    py2FaceR.py sync-photos -c config.conf ...

There are a couple ways to link photos. If you want everything in a directory
then ``-d DIR`` is for you. This can be specified multiple times to go through
several directories in one go. Individual files can be specified with 
``-f FILE``, and the -d command, the -f command can be specified multiple times.