From f38afe38911d49c03749ee4452e5afd97fe0af67 Mon Sep 17 00:00:00 2001 From: Matej Vadnjal Date: Sun, 29 Jan 2017 09:13:48 +0100 Subject: [PATCH] Small README cleanup --- README.rst | 37 ++++++++++++++++++++----------------- 1 file changed, 20 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index 025c04f..3541ca7 100644 --- a/README.rst +++ b/README.rst @@ -12,6 +12,22 @@ This client can query, edit, delete and create objects in a netdot installation via it's generic REST API [https://myserver.mydomain.com/netdot/rest/]. It exposes an interface similar to that of Django's models. +************ +Installation +************ + +pynetdot can be installed as any other python module. + +Via pip:: + + pip install pynetdot + +Install manually:: + + python setup.py install + +Pip is preferred. + ************* Configuration ************* @@ -37,6 +53,9 @@ environment variable. If this variable is not set, pynetdot will try to load This file will be read when you import pynetdot module. +Kerberos Single Sign-On authentication +====================================== + If you are using Kerberos Single Sign-On authentication for your netdot page, you may set your credentials like this: @@ -48,26 +67,10 @@ page, you may set your credentials like this: You will need to install requests_kerberos module first, and don't forget to perform kinit if you are running your script on a non-Windows machine. -You can enable Kerberos SSO in a YAML configuration file as well: +You can enable Kerberos SSO in a YAML configuration file as well:: kerberos: True -************ -Installation -************ - -pynetdot can be installed as any other python module. - -Via pip:: - - pip install pynetdot - -Install manually:: - - python setup.py install - -Pip is preferred. - ***** Usage *****