Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Browse files

docs about django client.

  • Loading branch information...
commit 04118b27e366be5821fc2f8c93d9267640a48546 1 parent 8a67fc6
@andrewsmedina andrewsmedina authored
Showing with 47 additions and 1 deletion.
  1. +45 −0 docs/drivers/django.rst
  2. +2 −1  docs/index.rst
View
45 docs/drivers/django.rst
@@ -0,0 +1,45 @@
+.. Copyright 2014 splinter authors. All rights reserved.
+ Use of this source code is governed by a BSD-style
+ license that can be found in the LICENSE file.
+
+.. meta::
+ :description: How to use splinter with django.
+ :keywords: splinter, python, tutorial, how to install, installation, django
+
+++++++++++++++++
+django client
++++++++++++++
+
+.. module:: splinter.driver.djangoclient
+
+To use the ``django`` driver, you need to install `django <http://pypi.python.org/pypi/django>`_,
+`lxml <https://pypi.python.org/pypi/lxml>`_ and `cssselect <http://pypi.python.org/pypi/cssselect>`_.
+You can install all of them in one step by running:
+
+.. highlight:: bash
+
+::
+
+ $ pip install splinter[django]
+
+Using django client
+-------------------
+
+To use the ``django`` driver, all you need to do is pass the string ``django`` when you create
+the ``Browser`` instance:
+
+.. highlight:: python
+
+::
+
+ from splinter import Browser
+ browser = Browser('django')
+
+**Note:** if you don't provide any driver to ``Browser`` function, ``firefox`` will be used.
+
+API docs
+--------
+
+.. autoclass:: DjangoClient
+ :members:
+ :inherited-members:
View
3  docs/index.rst
@@ -64,7 +64,8 @@ specific docs for each driver):
* :doc:`Phantomjs WebDriver </drivers/phantomjs>`
* :doc:`zope.testbrowser </drivers/zope.testbrowser>`
-*
+* :doc:`django client </drivers/django>`
+
Remote driver
++++++++++++++
Please sign in to comment.
Something went wrong with that request. Please try again.