pyfav2 0.1.1

pyfav2
-----

pyfav2 is a simple Python library that helps you get a `favicon`_ for a
supplied URL.

Favicons can be annoying to track down because they’re commonly located
in a handful of different places. pyfav2 removes the annoyance by
handling the details for you – you supply a URL and pyfav2 will give you
the favicon.

Exchange a URL for a favicon on disk
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

The simplest way to get started is to use the download\_favicon
function,

::

from pyfav2 import download_favicon

favicon_saved_at = download_favicon('https://www.python.org/')

You should now see the favicon in your /tmp directory. If you want to
control where the favicon gets written to disk,

::

from pyfav2 import download_favicon

mkdir /tmp/favicon-downloads

favicon_saved_at = download_favicon('https://www.python.org/', \
target_dir='/tmp/favicon-downloads')

Get the location
~~~~~~~~~~~~~~~~

If you’d prefer to handle the writing piece, use the get\_favicon\_url
function,

::

from pyfav2 import get_favicon_url

favicon_url = get_favicon_url('https://www.python.org/')

Install
~~~~~~~

The easiest to get pyfav2 is through PIP

::

pip install pyfav2

License
~~~~~~~

pyfav2 is open source and freely avaiable under the `MIT License`_

.. _favicon: http://en.wikipedia.org/wiki/Favicon
.. _MIT License: http://opensource.org/licenses/MIT