README

   1 Insider is a transaction-tracking application written in Python_ using
   2 the Django_ framework.
   3
   4 Install
   5 =======
   6
   7 Download
   8 --------
   9
  10 Insider is published as a Git_ repository.  See [insider's web
  11 interface][insider] for more information.
  12
  13 Dependencies
  14 ------------
  15
  16 Outside of Django_ and the Python_ standard libraries, the only
  17 required dependency is `django-tables2`_ (docs__).  For some of the
  18 scraping libraries (`insider/scrape/*`), you'll also need
  19 BeautifulSoup_.
  20
  21 __ dt2-docs_
  22
  23 Quick-start
  24 ===========
  25
  26 If you don't have a Django project and you just want to run insider as
  27 a stand-alone service, you can use the example project written up in
  28 `example`.  Set up the project (once)::
  29
  30   $ python example/manage.py syncdb
  31
  32 See the `Django documentation`_ for more details.
  33
  34 Run
  35 ===
  36
  37 Run the app on your local host (as many times as you like)::
  38
  39   $ python example/manage.py runserver
  40
  41 You may need to add the current directory to `PYTHONPATH` so `python`
  42 can find the `insider` package.  If you're running `bash`, that will
  43 look like
  44
  45   $ PYTHONPATH=".:$PYTHONPATH" python example/manage.py runserver
  46
  47 Hacking
  48 =======
  49
  50 This project was largely build following the `Django tutorial`_.
  51 That's a good place to start if you're new to Django.
  52
  53 .. _Python: http://www.python.org/
  54 .. _Django: https://www.djangoproject.com/
  55 .. _Git: http://git-scm.com/
  56 .. _insider: http://physics.drexel.edu/~wking/code/git/gitweb.cgi?p=insider.git
  57 .. _django-tables2: https://github.com/bradleyayers/django-tables2/
  58 .. _dt2-docs: http://django-tables2.readthedocs.org/en/latest/
  59 .. _BeautifulSoup: http://www.crummy.com/software/BeautifulSoup/
  60 .. _Django documentation: https://docs.djangoproject.com/
  61 .. _Django tutorial: https://docs.djangoproject.com/en/1.3/intro/tutorial01/