Insider is a transaction-tracking application written in Python_ using
the Django_ framework.

Install
=======

Download
--------

Insider is published as a Git_ repository.  See [insider's web
interface][insider] for more information.

Dependencies
------------

Outside of Django_ and the Python_ standard libraries, the only
required dependency is `django-tables2`_ (docs__).  For some of the
scraping libraries (`insider/scrape/*`), you'll also need
BeautifulSoup_.

__ dt2-docs_

Quick-start
===========

If you don't have a Django project and you just want to run insider as
a stand-alone service, you can use the example project written up in
`example`.  Set up the project (once)::

  $ python example/manage.py syncdb

See the `Django documentation`_ for more details.

Run
===

Run the app on your local host (as many times as you like)::

  $ python example/manage.py runserver

You may need to add the current directory to `PYTHONPATH` so `python`
can find the `insider` package.  If you're running `bash`, that will
look like

  $ PYTHONPATH=".:$PYTHONPATH" python example/manage.py runserver

Hacking
=======

This project was largely build following the `Django tutorial`_.
That's a good place to start if you're new to Django.

.. _Python: http://www.python.org/
.. _Django: https://www.djangoproject.com/
.. _Git: http://git-scm.com/
.. _insider: http://physics.drexel.edu/~wking/code/git/gitweb.cgi?p=insider.git
.. _django-tables2: https://github.com/bradleyayers/django-tables2/
.. _dt2-docs: http://django-tables2.readthedocs.org/en/latest/
.. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
.. _Django documentation: https://docs.djangoproject.com/
.. _Django tutorial: https://docs.djangoproject.com/en/1.3/intro/tutorial01/