Skip to content

Just update the README.md #271

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Nov 27, 2019
Merged

Just update the README.md #271

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a12997a
Updated docs with key/cert authentication
brianmcconnel Mar 13, 2019
9535b40
Merge pull request #1 from brianmcconnel/patch-2
brianmcconnel Mar 13, 2019
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
35 changes: 34 additions & 1 deletion docs/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
:alt: Codacy Badge