@@ -3,21 +3,40 @@ Atlassian Python API wrapper
33============================
44|Build Status | |PyPI version | |PyPI - Downloads | |License | |Codacy Badge | |Docs |
55
6+ What is it?
7+ ___________
8+ This package is used to provide a **simple ** python interface for interacting with Atlassian products (Server, Data Center and Cloud).
9+ It is based on the official public Rest API documentation and private methods (+ xml+rpc, raw http request).
10+
611Documentation
7- -------------
12+ _____________
813
914`Documentation `_
1015
1116.. _Documentation : https://atlassian-python-api.readthedocs.io
1217
13- Install
14- -------
18+ How to Install?
19+ _______________
20+
21+ From PyPI
22+
1523.. code-block :: console
1624
1725 $ pip install atlassian-python-api
1826
27+ From Source
28+
29+ - Git clone repository
30+ - Use `pip install -r requirements.txt ` to install the required packages
31+ - or `pipenv install && pipenv install --dev `
32+
33+ How to contribute?
34+ __________________
35+ Please, click here `Contribution Guidelines for this project `_
36+
37+
1938Examples
20- --------
39+ ________
2140**More examples in ``examples/`` directory. **
2241
2342Here's a short example of how to create a Confluence page:
@@ -105,7 +124,7 @@ If you want to see the response in pretty print format JSON. Feel free for use c
105124 pprint(response)
106125
107126 Development and Deployment (For contributors)
108- ---------------------------------------------
127+ _____________________________________________
109128First of all, I am happy for any PR requests.
110129Let's fork and provide your changes :)
111130See the `Contribution Guidelines for this project `_ for details on how to make changes to this library.
@@ -131,14 +150,17 @@ See the `Contribution Guidelines for this project`_ for details on how to make c
131150
132151
133152Credits
134- -------
153+ _______
135154In addition to all the contributors we would like to thank these vendors:
136155
137156* Atlassian _ for developing such a powerful ecosystem.
138157* JetBrains _ for providing us with free licenses of PyCharm _
158+ * Microsoft _ for providing us with free licenses of VSCode _
139159* Travis _ for hosting our continuous integration
140160
141161.. _Atlassian : https://www.atlassian.com/
142162.. _JetBrains : http://www.jetbrains.com
143163.. _PyCharm : http://www.jetbrains.com/pycharm/
144164.. _Travis : https://travis-ci.org/
165+ .. _Microsoft : https://github.com/Microsoft/vscode/
166+ .. _VSCode : https://code.visualstudio.com/
0 commit comments