url_shortener 0.5.8

url-shortener: demo URL shortening service in python
====================================================

A demo application for a very simple URL shortening service

The app relies on:

- _flask: A python micro web framework
- _bootstrap: A CSS & JS framework


Installing
----------

Pip:

``pip install url_shortener``

Pypi:

https://pypi-hypernode.com/pypi/url_shortener

Manual:

``python setup.py install``

Configuration
-------------

You can either modify the ``config.py`` file or provide environment
variables to configure ``url_shortener``. The following environment
variables can be tweaked:

- ``REDIS_HOST``: Address at which the redis server lives, defaults to ``127.0.0.1``.
- ``REDIS_PORT``: Port on which to contact redis, defaults to ``6379``.
- ``URL_PREFIX``: URL scheme for your short url host
- ``LISTEN_HOST``: Address to bind to for the short url service
- ``LISTEN_PORT``: Port to bind to
- ``RIEMANN_HOST``: Address to use to contact riemann
- ``RIEMANN_PORT``: Port to use to contact riemann

Logging
-------

When not run in debug mode, the application will output logs for consumption by
logstash, using _logstash_formatter

Usage
-----

The service can simply be started by invoking: ``url-shortener``, alternately deployments
can be done with _gunicorn. To start the service with gunicorn with 8 worker processes for
instance, the following can be used:

``
gunicorn -w 8 --log-file=/var/log/url-shortener/gunicorn.log --log-level=info url_shortener:app
``


.. _flask: http://flask.pocoo.org
.. _bootstrap: http://twitter.github.io/bootstrap
.. _logstash_formatter: https://github.com/exoscale/python-logstash-formatter
.. _gunicorn: http://gunicorn.org