Permalink
Browse files

Add documentation about testing.

  • Loading branch information...
1 parent b8f11ef commit 9911363ec7c02555a37dd0099285689e5294f573 @benspaulding committed May 26, 2012
Showing with 39 additions and 3 deletions.
  1. +3 −0 .travis.yml
  2. +6 −3 docs/getting_started.rst
  3. +1 −0 docs/index.rst
  4. +29 −0 docs/tests.rst
View
@@ -1,3 +1,6 @@
+# After any modifications to this file, be sure to check it with
+# http://lint.travis-ci.org/
+
language: python
python:
- 2.7
View
@@ -59,6 +59,12 @@ directory somewhere on your Python path, or symlink to it from
somewhere on your Python path; this is useful if you’re working from a
Git checkout.
+To run tests::
+
+ django-admin.py test gcframe --settings="gcframe.tests.settings"
+
+For more information on tests see :doc:`tests`.
+
You can then begin using the middleware and/or decorators in your
Django project.
@@ -99,9 +105,6 @@ tracker`_.
.. _GitHub issue tracker: https://github.com/benspaulding/django-gcframe/issues/
-This package does not yet have a test suite, but one will be written in
-the near future.
-
Features Not Yet Included
~~~~~~~~~~~~~~~~~~~~~~~~~
View
@@ -37,6 +37,7 @@ Contents
middleware
decorators
settings
+ tests
Indices, etc.
View
@@ -0,0 +1,29 @@
+.. _index:
+.. module:: gcframe.tests
+ :synopsis: How to check current build status and run tests locally.
+
+Tests
+=====
+
+|Build status|_
+
+.. |Build status| image::
+ https://secure.travis-ci.org/benspaulding/django-gcframe.png
+.. _Build status: http://travis-ci.org/benspaulding/django-dcframe
+
+``gcframe`` has a decent test suite, though it can and will be improved in time.
+
+Current build status can be found at
+http://travis-ci.org/benspaulding/django-gcframe.
+
+To run tests, be sure Django is installed, then run::
+
+ django-admin.py test gcframe --settings="gcframe.tests.settings"
+
+If you have not installed ``gcframe``, but are working from a Git checkout, you
+will need to either have it on your ``PYTHONPATH`` or run the above command from
+the root of the repository.
+
+.. note:: In order for ``gcframe`` tests to run in your project, you will need
+ to add ``gcframe`` to your ``INSTALLED_APPS``. (Mentioned here because
+ no other ``gcframe`` functionality requires this.)

0 comments on commit 9911363

Please sign in to comment.