[JIRA] Documentation and example addition for getting all projects

atlassian/jira.py

@@ -2073,6 +2073,14 @@ def get_project_issues_count(self, project):
         return self.jql(jql, fields="*none")["total"]
 
     def get_all_project_issues(self, project, fields="*all", start=0, limit=None):
+        """
+        Get the Issues for a Project
+        :param project: Project Key name
+        :param fields: OPTIONAL list<str>: List of Issue Fields
+        :param start: OPTIONAL int: Starting index/offset from the list of target issues
+        :param limit: OPTIONAL int: Total number of project issues to be returned
+        :return: List of Dictionary for the Issue(s) returned.
+        """
         jql = "project = {project} ORDER BY key".format(project=project)
         return self.jql(jql, fields=fields, start=start, limit=limit)["issues"]
 

examples/jira/jira_issues_get_all_projects.py

@@ -0,0 +1,19 @@
+# coding=utf-8
+"""
+    Getting Project Issue(s) example
+"""
+
+
+from atlassian import Jira
+
+
+jira = Jira(url="https://jirasite.co", username="ocean", password="seariver")
+
+
+if __name__ == "__main__":
+    # default will return 50 issues in ascending order
+    project_issues_default_50 = jira.get_all_project_issues(project="APA")
+    # We can increase the limit by specifying the limit
+    project_issues_100 = jira.get_all_project_issues(project="APA", limit=100)
+    # Specifying specific fields other than the default jira fields returned
+    project_issues_specific = jira.get_all_project_issues(project="APA", fields=["description", "summary"], limit=100)