Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Improved documentation adding testing

  • Loading branch information...
commit 3f860e936870ada51cba4ddf58dd1bbe12cb559e 1 parent ea170a2
@camilonova camilonova authored
Showing with 26 additions and 16 deletions.
  1. +26 −16 README.rst
View
42 README.rst
@@ -15,33 +15,29 @@ Requirements
work around the Django admin and the regular ``django.contrib.auth``
login-powered pages.
+
Installation
============
-Download ``django-axes`` using **one** of the following methods:
-
-easy_install
-------------
+Download and install ``django-axes`` using **one** of the following methods:
-You can download the package from the `CheeseShop <http://pypi.python.org/pypi/django-axes/>`_ or use::
+PIP
+---
- easy_install django-axes
+You can install the latest stable package running this command::
-to download and install ``django-axes``.
+ $ pip install django-axes
-Package Download
-----------------
+Also you can install the development version running this command::
-Download the latest ``.tar.gz`` file from the downloads section and extract it
-somewhere you'll remember. Use ``python setup.py install`` to install it.
+ $ pip install -e git+http://github.com/codekoala/django-axes.git#egg=django_axes-dev
-Checkout from GitHub
---------------------
+Setuptools
+----------
-Execute the following command, and make sure you're checking ``django-axes``
-out somewhere on the ``PYTHONPATH``::
+You can install the latest stable package running::
- git clone git://github.com/codekoala/django-axes.git
+ $ easy_install django-axes
Verifying Installation
----------------------
@@ -55,6 +51,20 @@ If that command completes with some sort of version number, you're probably
good to go. If you see error output, you need to check your installation (I'd
start with your ``PYTHONPATH``).
+
+Development
+===========
+
+You can contribute to this project forking it from github and sending pull requests.
+
+Running tests
+-------------
+
+Tests can be run, after you clone the repository and having django installed, like::
+
+ $ PYTHONPATH=$PYTHONPATH:$PWD django-admin.py test axes --settings=axes.test_settings
+
+
Configuration
=============
Please sign in to comment.
Something went wrong with that request. Please try again.