From 24dd3be36a127ba09283e9b94e5ca75f30be8af4 Mon Sep 17 00:00:00 2001 From: Adam Coddington Date: Wed, 13 Aug 2014 17:40:03 -0700 Subject: [PATCH] Minor alterations and clarifications to @fsboehme's fantastic addition. --- docs/topics/installation.rst | 37 +++++++++++++++++++++++++----------- 1 file changed, 26 insertions(+), 11 deletions(-) diff --git a/docs/topics/installation.rst b/docs/topics/installation.rst index e8343b9..bb5cc5a 100644 --- a/docs/topics/installation.rst +++ b/docs/topics/installation.rst @@ -2,21 +2,36 @@ Installation ============ -You can either install from pip:: +1. You can either install from pip:: - pip install django-mailbox + pip install django-mailbox + + *or* checkout and install the source from the `github repository `_:: + + git clone https://github.com/coddingtonbear/django-mailbox.git + cd django-mailbox + python setup.py install -*or* checkout and install the source from the `github repository `_:: +2. After you have installed the package, + add ``django_mailbox`` to the ``INSTALLED_APPS`` setting in + your project's ``settings.py`` file. - git clone https://github.com/coddingtonbear/django-mailbox.git - cd django-mailbox - python setup.py install +3. From your project folder, run ``python manage.py migrate django_mailbox`` to + create the required database tables. -After you have installed the package, -you should add ``django_mailbox`` to the ``INSTALLED_APPS`` setting in your project's ``settings.py`` file. +4. Head to your project's Django Admin and create a mailbox to consume. -Run ``python manage.py migrate django_mailbox`` to create the required database tables. -Head to your admin and create a mailbox to consume (see next docs page). +.. note:: + + Once you have entered a mailbox to consume, you can easily verify that you + have properly configured your mailbox by either: + + * From the Django Admin, using the 'Get New Mail' action from the action + dropdown on the Mailbox changelist + (http://yourproject.com/admin/django_mailbox/mailbox/). + * *Or* from a shell opened to your project's directory, using the + ``getmail`` management command by running:: + + python manage.py getmail -Test your setup by selecting 'Get new mail' from the action dropdown in the Mailbox change list.