Skip to content
This repository has been archived by the owner on Feb 7, 2024. It is now read-only.

Commit

Permalink
Updated readme file
Browse files Browse the repository at this point in the history
  • Loading branch information
Eagllus committed Jun 3, 2014
1 parent f1a7a45 commit 8b9e9b5
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,16 +3,16 @@ django-pypuppetdb
#################

.. image:: https://api.travis-ci.org/nedap/django-pypuppetdb.png
:target: https://travis-ci.org/nedap/django-pypuppetdb
:target: https://travis-ci.org/nedap/django-pypuppetdb

.. image:: https://coveralls.io/repos/nedap/django-pypuppetdb/badge.png
:target: https://coveralls.io/r/nedap/django-pypuppetdb
:target: https://coveralls.io/r/nedap/django-pypuppetdb

.. image:: https://pypip.in/d/django_pypuppetdb/badge.png
:target: https://pypi.python.org/pypi/django_pypuppetdb
:target: https://pypi.python.org/pypi/django_pypuppetdb

.. image:: https://pypip.in/v/django_pypuppetdb/badge.png
:target: https://crate.io/packages/django-pypuppetdb
:target: https://crate.io/packages/django-pypuppetdb

django-pypuppetdb is a library that handles authentication
by using the PuppetDB's REST API to get Users that are registrated
Expand All @@ -32,9 +32,11 @@ Installation
You can install this package from source or from PyPi.

.. code-block:: bash
$ pip install django-pypuppetdb
.. code-block:: bash
$ git clone https://github.com/nedap/django-pypuppetdb
$ python setup.py install
Expand All @@ -43,10 +45,14 @@ Django

To let django connect to puppetdb in order to get your user
add the following line to you settings.
.. code-block:: python

* add "django_pypuppetdb" to INSTALLED_APPS.
* add "django_pypuppetdb.django_authentication.PuppetDBAuthentication" to AUTHENTICATION_BACKENDS

* add the followin settings

.. code-block:: python
PUPPETDB_HOST = 'localhost',
PUPPETDB_PORT = 8080,
PUPPETDB_NODE = 'node',
Expand All @@ -59,14 +65,18 @@ Tastypie

If you are using tastypie as API framework and want to use pypuppetdb to
validate the user you can add the following line to your resource file

.. code-block:: python
from django_pypuppetdb.tastypie_authentication import PuppetDBAuthentication
in your class Meta add:
authentication = PuppetDBAuthentication()
if you would like to use multiple authentications you can use

.. code-block:: python
authentication = MultiAuthentication(ApiKeyAuthentication(), PuppetDBAuthentication())
Getting Help
Expand All @@ -78,4 +88,4 @@ For bug reports you can file an `issue`_. If you need help with something
feel free to hit up `@eagllus`_ by e-mail.

.. _issue: https://github.com/nedap/pypuppetdb/issues
.. _@eagllus: https://github.com/daenney
.. _@eagllus: https://github.com/eagllus

0 comments on commit 8b9e9b5

Please sign in to comment.