Skip to content

Commit

Permalink
UPDATE Usage.rst
Browse files Browse the repository at this point in the history
  • Loading branch information
K-Gazdikova committed Jun 16, 2017
1 parent 686616f commit fb53afd
Showing 1 changed file with 36 additions and 31 deletions.
67 changes: 36 additions & 31 deletions read-the-docs/source/Usage.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,50 +3,55 @@ Usage

**The general usage workflow for creating new tickets is:**

.. glossary::
Basics - I
^^^^^^^^^^
Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project>`` and ``<auth>``. This
verifies that you are able to properly authenticate to the ticketing tool.
To use HTTP Basic Authentication, the ``<auth>`` parameter should contain the
username and password specified as a tuple. For tools that support kerberos
authentication (JIRA and RT), the ``<auth>`` parameter should contain
'kerberos'.

Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project>`` and ``<auth>``. This
verifies that you are able to properly authenticate to the ticketing tool.
To use HTTP Basic Authentication, the ``<auth>`` parameter should contain the
username and password specified as a tuple. For tools that support kerberos
authentication (JIRA and RT), the ``<auth>`` parameter should contain
'kerberos'.

.. glossary::
How to:
-------

- Create a ticket with the ``create()`` method. This sets the ``ticket_id``
instance variable, allowing you to perform more tasks on the ticket.
- Create a ticket with the ``create()`` method. This sets the ``ticket_id``
instance variable, allowing you to perform more tasks on the ticket.

- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.
- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.

- Close ticket Requests session with ``close_requests_session()``.
- Close ticket Requests session with ``close_requests_session()``.

- To work on existing tickets, you can also pass in a fourth parameter
when creating a Ticket object: ``<ticket_id>``. The general workflow for
working with existing tickets is as follows:
- To work on existing tickets, you can also pass in a fourth parameter
when creating a Ticket object: ``<ticket_id>``. The general workflow for
working with existing tickets is as follows:

- Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project_key>``, ``<auth>`` and
``<ticket_id>``.
- Create a JiraTicket, RTTicket, RedmineTicket, BugzillaTicket
or ServiceNowTicket object with ``<url>``, ``<project_key>``, ``<auth>`` and
``<ticket_id>``.

- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.
- Add comments, edit ticket fields, add watchers, change the ticket
status, etc on the ticket.

- Close ticket Requests session with ``close_requests_session()``.
- Close ticket Requests session with ``close_requests_session()``.

* There is also a ``set_ticket_id()`` method for a Ticket object. This is
useful if you are working with a Ticket object that already has the
``<ticket_id>`` instance variable set, but would like to begin working
on a separate ticket. Instead of creating a new Ticket object, you can
simply pass an existing ``<ticket_id>`` in to the ``set_ticket_id()``
method to begin working on another ticket.
Basics - II
^^^^^^^^^^^
There is also a ``set_ticket_id()`` method for a Ticket object. This is
useful if you are working with a Ticket object that already has the
``<ticket_id>`` instance variable set, but would like to begin working
on a separate ticket. Instead of creating a new Ticket object, you can
simply pass an existing ``<ticket_id>`` in to the ``set_ticket_id()``
method to begin working on another ticket.

* To return the current Ticket object's ticket_id or ticket_url, use the

- To return the current Ticket object's ticket_id or ticket_url, use the
``get_ticket_id()`` or ``get_ticket_url()`` methods.

* To run unit tests in Bash terminal use this command:
- To run unit tests in Bash terminal use this command:

.. code-block:: python
Expand Down

0 comments on commit fb53afd

Please sign in to comment.