Docs:

 - Modify index page
 - Jira module docs moved from index page to jira page
 - Add Confluence docs
 - Update license

Author: SLRover

docs/conf.py

@@ -20,13 +20,13 @@
 # -- Project information -----------------------------------------------------
 
 project = 'Atlassian Python API'
-copyright = '2018, SLRover'
+copyright = 'APACHE LICENSE, VERSION 2.0'
 author = 'SLRover'
 
 # The short X.Y version
 version = ''
 # The full version, including alpha/beta/rc tags
-release = '1.10.0'
+release = '1.10.2'
 
 
 # -- General configuration ---------------------------------------------------

docs/confluence.rst

@@ -0,0 +1,153 @@
+Confluence module
+=================
+
+Get page info
+-------------
+
+.. code-block:: python
+
+    # Check page exists
+    confluence.page_exists(space, title)
+
+    # Provide content by type (page, blog, comment)
+    confluence.get_page_child_by_type(page_id, type='page', start=None, limit=None)
+
+    # Provide content id from search result by title and space
+    confluence.get_page_id(space, title)
+
+    # Provide space key from content id
+    confluence.get_page_space(page_id)
+
+    # Returns the list of labels on a piece of Content
+    confluence.get_page_by_title(space, title, start=None, limit=None)
+
+    # Get page by ID
+    confluence.get_page_by_id(page_id, expand=None)
+
+    # The list of labels on a piece of Content
+    confluence.get_page_labels(page_id, prefix=None, start=None, limit=None)
+
+    # Get draft page by ID
+    confluence.get_draft_page_by_id(page_id, status='draft')
+
+    # Get all page by label
+    confluence.get_all_pages_by_label(label, start=0, limit=50)
+
+    # Get all pages from Space
+    confluence.get_all_pages_from_space(space, start=0, limit=500)
+
+    # Get list of pages from trash
+    confluence.get_all_pages_from_space_trash(space, start=0, limit=500, status='trashed')
+
+    # Get list of draft pages from space
+    # Use case is cleanup old drafts from Confluence
+    confluence.get_all_draft_pages_from_space(space, start=0, limit=500, status='draft')
+
+    # Search list of draft pages by space key
+    # Use case is cleanup old drafts from Confluence
+    confluence.get_all_draft_pages_from_space_through_cql(space, start=0, limit=500, status='draft')
+
+    # Info about all restrictions by operation
+    confluence.get_all_restictions_for_content(content_id)
+
+Page actions
+------------
+
+.. code-block:: python
+
+    # Create page from scratch
+    confluence.create_page(space, title, body, parent_id=None, type='page')
+
+    # Remove page
+    confluence.remove_page(page_id, status=None)
+
+    # Remove page from trash
+    confluence.remove_page_from_trash(page_id)
+
+    # Remove page as draft
+    confluence.remove_page_as_draft(page_id)
+
+    # Update page if already exist
+    confluence.update_page(parent_id, page_id, title, body, type='page')
+
+    # Update page or create page if it is not exists
+    confluence.update_or_create(parent_id, title, body)
+
+    # Set the page (content) property e.g. add hash parameters
+    confluence.set_page_property(page_id, data)
+
+    # Delete the page (content) property e.g. delete key of hash
+    confluence.delete_page_property(page_id, page_property)
+
+    # Get the page (content) property e.g. get key of hash
+    confluence.get_page_property(page_id, page_property_key)
+
+    # Get the page (content) properties
+    confluence.get_page_properties(page_id)
+
+    # Get page ancestors
+    confluence.get_page_ancestors(page_id)
+
+    # Attach (upload) a file to a page, if it exists it will update the
+    # automatically version the new file and keep the old one
+    confluence.attach_file(filename, page_id=None, title=None, space=None, comment=None)
+
+Get spaces info
+---------------
+
+.. code-block:: python
+
+    # Get all spaces with provided limit
+    confluence.get_all_spaces(start=0, limit=500)
+
+    # Get information about a space through space key
+    confluence.get_space(space_key, expand='description.plain,homepage')
+
+Users and Groups
+----------------
+
+.. code-block:: python
+
+    # Get all groups from Confluence User management
+    confluence.get_all_groups(start=0, limit=1000)
+
+    # Get a paginated collection of users in the given group
+    confluence.get_group_members(group_name='confluence-users', start=0, limit=1000)
+
+    # Get information about a user through username
+    confluence.get_user_details_by_username(username, expand=None)
+
+    # Get information about a user through user key
+    confluence.get_user_details_by_userkey(userkey, expand=None)
+
+CQL
+---
+
+.. code-block:: python
+
+    # Get results from cql search result with all related fields
+    confluence.cql(cql, start=0, limit=None)
+
+Other actions
+-------------
+
+.. code-block:: python
+
+    # Clean all caches from cache management
+    confluence.clean_all_caches()
+
+    # Clean caches from cache management
+    # e.g.
+    # com.gliffy.cache.gon
+    # org.hibernate.cache.internal.StandardQueryCache_v5
+    confluence.clean_package_cache(cache_name='com.gliffy.cache.gon')
+
+    # Convert to Confluence XHTML format from wiki style
+    confluence.convert_wiki_to_storage(wiki)
+
+    # Get page history
+    confluence.history(page_id)
+
+    # Compare content and check is already updated or not
+    confluence.is_page_content_is_already_updated(page_id, body)
+

docs/index.rst

@@ -37,165 +37,6 @@ Add a connection:
         username='admin',
         password='admin')
 
-Jira
-----
-
-* Get issues from jql search result with all related fields:
-
-.. code-block:: python
-
-    jql_request = 'project = DEMO AND status NOT IN (Closed, Resolved) ORDER BY issuekey'
-    issues = jira.jql(jql_request)
-    print(issues)
-
-* Reindex Jira
-
-.. code-block:: python
-
-    # Reindexing Jira
-    jira.reindex()
-
-    # Reindex status
-    jira.reindex_status()
-
-    # Reindex type
-    jira.reindex_with_type(indexing_type="BACKGROUND_PREFERRED")
-    """
-    FOREGROUND - runs a lock/full reindexing
-    BACKGROUND - runs a background reindexing.
-                 If JIRA fails to finish the background reindexing, respond with 409 Conflict (error message).
-    BACKGROUND_PREFERRED  - If possible do a background reindexing.
-                            If it's not possible (due to an inconsistent index), do a foreground reindexing.
-    """
-
-* Manage users
-
-.. code-block:: python
-
-    # Get user
-    jira.user(username)
-
-    # Remove user
-    jira.user_remove(username)
-
-    # Deactivate user
-    jira.user_deactivate(username)
-
-    # Get web sudo cookies using normal http request
-    jira.user_get_websudo()
-
-    # Fuzzy search using username and display name
-    jira.user_find_by_user_string(username, start=0, limit=50, include_inactive_users=False)
-
-    # Get all users from group
-    jira.get_all_users_from_group(group, include_inactive_users=False, start=0, limit=50)
-
-* Manage projects
-
-.. code-block:: python
-
-    # Get all projects
-    jira.projects()
-
-    # Get project
-    jira.project(key)
-
-    # Get project components using project key
-    jira.get_project_components(key)
-
-    # Get a full representation of a the specified project's versions
-    jira.get_project_versions(key, expand=None)
-
-    # Returns all versions for the specified project. Results are paginated.
-    # Results can be ordered by the following fields: sequence, name, startDate, releaseDate.
-    jira.get_project_versions_paginated(key, start=None, limit=None, order_by=None, expand=None)
-
-    # Get project leaders
-    jira.project_leaders()
-
-    # Get last project issuekey
-    jira.get_project_issuekey_last(project)
-
-    # Get all project issue keys
-    jira.get_project_issuekey_all(project)
-
-    # Get project issues count
-    jira.get_project_issues_count(project)
-
-    # Get all project issues
-    jira.get_all_project_issues(project, fields='*all')
-
-    # Get all assignable users for project
-    jira.get_all_assignable_users_for_project(project_key, start=0, limit=50)
-
-* Manage issues
-
-.. code-block:: python
-
-    # Get issue by key
-    jira.issue(key)
-
-    # Get issue field value
-    jira.issue_field_value(key, field)
-
-    # Update issue field
-    fields = {'summary': 'New summary'}
-    jira.update_issue_field(key, fields)
-
-    # Rename sprint
-    jira.rename_sprint(sprint_id, name, start_date, end_date)
-
-    # Check issue exists
-    jira.issue_exists(issue_key)
-
-    # Check issue deleted
-    jira.issue_deleted(issue_key)
-
-    # Update issue
-    jira.issue_update(issue_key, fields)
-
-    # Create issue
-    jira.issue_create(fields)
-
-    # Issue create or update
-    jira.issue_create_or_update(fields)
-
-    # Get issue transitions
-    jira.get_issue_transitions(issue_key)
-
-    # Get status ID from name
-    jira.get_status_id_from_name(status_name)
-
-    # Get transition id to status name
-    jira.get_transition_id_to_status_name(issue_key, status_name)
-
-    # Transition issue
-    jira.issue_transition(issue_key, status)
-
-    # Set issue status
-    jira.set_issue_status(issue_key, status_name)
-
-    # Get issue status
-    jira.get_issue_status(issue_key)
-
-* Manage components
-
-.. code-block:: python
-
-    # Get component
-    jira.component(component_id)
-
-    # Create component
-    jira.create_component(component)
-
-    # Delete component
-    jira.delete_component(component_id)
-
-* Upload Jira plugin
-
-.. code-block:: python
-
-    upload_plugin(plugin_path)
 
 
 .. |Build Status| image:: https://travis-ci.org/AstroMatt/atlassian-python-api.svg?branch=master