Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse code

Better docs

  • Loading branch information...
commit 17cfc3fb6a2883d3eba5647d61dc5975f51ed6a9 1 parent 6f55872
Peter Baumgartner ipmb authored

Showing 1 changed file with 23 additions and 2 deletions. Show diff stats Hide diff stats

  1. +23 2 README.rst
25 README.rst
Source Rendered
... ... @@ -1,6 +1,19 @@
1 1 A mini-site for checking Google's GMail feed with Oauth. See a live example at http://emailed-me.appspot.com
2 2
3   -To run on App Engine, simply run::
  3 +Setup
  4 +-----
  5 +
  6 +Copy ``secrets.py.example`` to ``secrets.py`` and fill in the necessary information.
  7 +
  8 +* ``SECRET_KEY`` is used by Flask. Run ``import os; os.random(24)`` and paste its results
  9 +* ``CONSUMER_KEY`` and ``CONSUMER_SECRET`` will work as is, or you can `register your app and get a key/secret from Google <http://code.google.com/apis/accounts/docs/OAuth.html#prepRegister>`_
  10 +* ``TEST_GOOGLE_EMAIL`` and ``TEST_GOOGLE_PASSWORD`` can be used to test your application, but aren't required otherwise.
  11 +
  12 +
  13 +Run
  14 +---
  15 +
  16 +To run using the `App Engine SDK <http://code.google.com/appengine/downloads.html#Google_App_Engine_SDK_for_Python>`_, simply run::
4 17
5 18 dev_appserver.py .
6 19
@@ -13,4 +26,12 @@ To run outside of App Engine, either:
13 26
14 27 then run::
15 28
16   - python application.py
  29 + python application.py
  30 +
  31 +
  32 +Test (optional)
  33 +---------------
  34 +
  35 +Testing is done using Twill. It is easiest to install the requirements via ``pip install -r requirements.pip``, then run::
  36 +
  37 + python tests.py

0 comments on commit 17cfc3f

Please sign in to comment.
Something went wrong with that request. Please try again.