Skip to content

Commit 2f3d555

Browse files
author
Matt Harasymczuk
authored
Readme minor changes
1 parent 2d0c5ef commit 2f3d555

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

README.rst

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,13 @@ Documentation
1212

1313
Examples
1414
--------
15+
.. tip:: More examples in ``examples/`` directory.
1516

1617
For everyday normal use, just install package using pip
1718

18-
::
19+
.. code-block:: console
1920
20-
pip install atlassian-python-api
21+
$ pip install atlassian-python-api
2122
2223
Here's a short example how to create a Confluence page:
2324

@@ -49,6 +50,7 @@ And here's another example how to get issues from Jira using JQL Query:
4950
password='admin')
5051
5152
JQL = 'project = DEMO AND status NOT IN (Closed, Resolved) ORDER BY issuekey'
53+
5254
data = jira.jql(JQL)
5355
print(data)
5456
@@ -62,6 +64,7 @@ Also, you can use the Bitbucket module e.g. for get project list
6264
url='http://localhost:7990',
6365
username='admin',
6466
password='admin')
67+
6568
data = bitbucket.project_list()
6669
print(data)
6770
@@ -76,10 +79,10 @@ Example to get your requests:
7679
url='http://localhost:7990',
7780
username='admin',
7881
password='admin')
79-
my_requests = sd.get_my_customer_requests()
80-
print(my_requests)
82+
83+
data = sd.get_my_customer_requests()
84+
print(data)
8185
82-
Please make sure, you've checked ``examples/`` directory on how to build scripts using the API.
8386
If you want to see response in pretty print format json. Feel free for use construction like:
8487

8588
.. code-block:: python

0 commit comments

Comments
 (0)