From a12997a6f71f56af1f836f2d5e5454d030f45736 Mon Sep 17 00:00:00 2001 From: bcmc Date: Wed, 13 Mar 2019 11:55:22 -0700 Subject: [PATCH] Updated docs with key/cert authentication Added key/cert authentication to documentation --- docs/index.rst | 35 ++++++++++++++++++++++++++++++++++- 1 file changed, 34 insertions(+), 1 deletion(-) diff --git a/docs/index.rst b/docs/index.rst index c931be1aa..c936ee555 100644 --- a/docs/index.rst +++ b/docs/index.rst @@ -42,6 +42,39 @@ Add a connection: url='http://localhost:8080', username='admin', password='admin') + + +Key/Cert Based authentication +----------------------------- + +Add a connection using key/cert based authentication: + +.. code-block:: python + + from atlassian import Jira + from atlassian import Confluence + from atlassian import Bitbucket + from atlassian import ServiceDesk + + jira = Jira( + url='http://localhost:8080', + key='/path/to/key', + cert='/path/to/cert') + + confluence = Confluence( + url='http://localhost:8090', + key='/path/to/key', + cert='/path/to/cert') + + bitbucket = Bitbucket( + url='http://localhost:7990', + key='/path/to/key', + cert='/path/to/cert') + + service_desk = ServiceDesk( + url='http://localhost:8080', + key='/path/to/key', + cert='/path/to/cert') .. toctree:: :maxdept:2 @@ -62,4 +95,4 @@ Add a connection: :alt: License .. |Codacy Badge| image:: https://api.codacy.com/project/badge/Grade/c822908f507544fe98ae37b25518ae3d :target: https://www.codacy.com/project/gonchik/atlassian-python-api/dashboard?utm_source=github.com&utm_medium=referral&utm_content=AstroMatt/atlassian-python-api&utm_campaign=Badge_Grade_Dashboard - :alt: Codacy Badge \ No newline at end of file + :alt: Codacy Badge