Bump version and review contribution page

Author: Gonchik Tsymzhitov

CONTRIBUTING.rst

@@ -11,10 +11,11 @@ Getting Started
 * Fork_ repository
 * Keep it sync_'ed while you are developing
 * Install pyenv_
-* Install related atlassian product for testing through SDK_
-* pip install -r requirements.txt
-* Start up related product
-  - atlas-run-standalone_
+* Install related atlassian product for testing through SDK_ or use the cloud instance
+* ``pip install -r requirements-dev.txt``
+* Start up related product:
+  - Standalone product atlas-run-standalone_
+  - For cloud product, just do registration
 * Send pull request
 
 .. _Fork: https://help.github.com/articles/fork-a-repo/
@@ -57,7 +58,8 @@ All methods based on docs from: https://developer.atlassian.com/docs/
 
 * `Jira Server`_
 * `Jira Cloud`_
-* Confluence_
+* `Confluence Server`_
+* `Confluence Cloud`_
 * `Jira Service Desk Server`_
 * `Jira Service Desk Cloud`_
 * `Portfolio for Jira`_
@@ -80,8 +82,9 @@ All methods based on docs from: https://developer.atlassian.com/docs/
     - https://confluence.atlassian.com/cloud/api-tokens-938839638.html
 
 .. _`Jira Server`: https://docs.atlassian.com/software/jira/docs/api/REST/latest
-.. _Jira Cloud: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
-.. _Confluence: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
+.. _`Jira Cloud`: https://developer.atlassian.com/cloud/jira/platform/rest/v3/
+.. _`Confluence Server`: https://developer.atlassian.com/server/confluence/confluence-server-rest-api/
+.. _`Confluence Cloud`: https://developer.atlassian.com/cloud/confluence/rest/
 .. _`Jira Service Desk Cloud`: https://developer.atlassian.com/cloud/jira/service-desk/rest/
 .. _`Jira Service Desk Server`: https://docs.atlassian.com/jira-servicedesk/REST/server
 .. _`Portfolio for Jira Teams`: https://docs.atlassian.com/portfolio-for-jira-server/REST/2.13.0/teams/
@@ -95,8 +98,9 @@ In addition to all the contributors we would like to thank to these companies:
 * Atlassian_ for developing such a powerful ecosystem.
 * JetBrains_ for providing us with free licenses of PyCharm_
 * Travis_ for hosting our continuous integration
-
+* Insomnia_ for providing the human rest client easy to test the methods
 .. _Atlassian: https://www.atlassian.com/
 .. _JetBrains: http://www.jetbrains.com
 .. _PyCharm: http://www.jetbrains.com/pycharm/
 .. _Travis: https://travis-ci.org/
+.. _Insomnia: https://insomnia.rest/

atlassian/VERSION

@@ -1 +1 @@
-1.15.5
+1.15.6

atlassian/bamboo.py

@@ -33,7 +33,7 @@ def _get_generator(self, path, elements_key='results', element_key='result', dat
         :return: generator with the contents of response[elements_key][element_key]
         """
         start_index = 0
-        params['start-index'] = start_index
+        params["start-index"] = start_index
         response = self.get(path, data, flags, params, headers)
         if self.advanced_mode:
             try:
@@ -46,20 +46,20 @@ def _get_generator(self, path, elements_key='results', element_key='result', dat
             results = response[elements_key]
             size = 0
             # Check if we still can get results
-            if size > max_results or results['size'] == 0:
+            if size > max_results or results["size"] == 0:
                 return
             for r in results[element_key]:
                 size += 1
                 yield r
-            start_index += results['max-result']
+            start_index += results["max-result"]
         except TypeError:
             logging.error("Broken response: {}".format(response))
             yield response
 
     def base_list_call(self, resource, expand, favourite, clover_enabled, max_results, label=None, start_index=0,
                        **kwargs):
         flags = []
-        params = {'max-results': max_results}
+        params = {"max-results": max_results}
         if expand:
             params['expand'] = expand
         if favourite:

examples/README.md

@@ -8,4 +8,5 @@ There are simple rules each example should follow:
 * **Do not store** any credentials in VCS
 * Do not use any additional dependencies except the python build-in's
 * Follow the PEP-8 and format your code. 
-JetBrains built-in formatter is perfectly fine and used a lot at this library
+
+JetBrains PyCharm built-in formatter is perfectly fine and used a lot at this library

examples/bamboo/bamboo-activity.py

@@ -2,6 +2,9 @@
 from atlassian import Bamboo
 import os
 
+"""
+    Example for check exist activity and agent status
+"""
 BAMBOO_URL = os.environ.get('BAMBOO_URL', 'http://localhost:8085')
 ATLASSIAN_USER = os.environ.get('ATLASSIAN_USER', 'admin')
 ATLASSIAN_PASSWORD = os.environ.get('ATLASSIAN_PASSWORD', 'admin')

examples/bamboo/bamboo-add-plan-branch.py

@@ -2,6 +2,9 @@
 from atlassian import Bamboo
 import argparse
 
+"""
+    How to create the plan branch
+"""
 bamboo = Bamboo(url="https://", username="", password="")