gitticket 0.5.1

Git and issue tracking system integration

==========
git-ticket
==========

git-ticket is a git extension to help developers manage the issue/ticket tracking system.

git-ticket supports **github**, **bitbucket**, and **redmine**.

This tool is currentry **under development** state and not tested enough.


----------
Screenshot
----------

list command:

.. image:: https://raw.github.com/aflc/git-ticket/gh-pages/ex_list.png
:scale: 100%

show command:

.. image:: https://raw.github.com/aflc/git-ticket/gh-pages/ex_show.png
:scale: 100%

------------
Installation
------------

From PyPI::

pip install gitticket

or github(unstable)::

pip install -e git+https://github.com/aflc/git-ticket.git#egg=git-ticket


-------------
Upgrade notes
-------------

If you have something errors, try ``pip install gitticket -U``

-----
Usage
-----

configuration
=============

For github::

git config ticket.github.token <your_access_token>

To get your access token, try this::

git ticket github-authorize

For bitbucket::

git config ticket.bitbucket.token <your_access_token>
git config ticket.bitbucket.token-secret <your_access_token_secret>

To get your access token and access token secret, try this::

git ticket bitbucket-authorize

For redmine::

git config ticket.redmine.token <your_apikey>
git config ticket.redmine.url <your_redmine_root>

And some other settings::

git config ticket.name <your_account_name_for_a_service> # if no value, guess from user.name
git config ticket.service <service_name> # if no value, guess from origin url
git config ticket.repo <repository_name> # if no value, guess from origin url or root derectory name.

For Redmine service, you must set ticket.service=redmine.

Simple usage
============

::

git ticket list # list tickets
git ticket show <ticket id> # show detail of the ticket
git ticket add # add a ticket
git ticket update <ticket id> # update contents of the ticket
git ticket comment <ticket id> # add comment to the ticket
git ticket close <ticket id> # close the ticket

More coomand
============

::

git ticket locals
git ticket show-config

* "locals" command find a ticket id in your local branch name.
The branch name should contains '#xx', 'id-xx', 'idxx' or 'id/xx', xx is a ticket number.
* "show-config" command outputs your configurations.


-----------
ReleaseNote
-----------

v0.5.1
* Fixed: support newer virsion of requests

v0.5
* New: locals command
* New: show-config command
* Fixed: #17
* Fixed: rauth.hook import error

v0.4.1
* Updated: more error handlings.
* Fixed: #16 parse error of a Redmine's journal

v0.4
* New: display format of list, show, add, update command.
* Fixed: #15 Automatic guessing of a ticket service was not functioned.

v0.3.1
* Fixed: crash if comment number is 0.
* Fixed: fixed #13
* Fixed: fixed #12 Change SSL settings with git's http.sslVerify configuration.
* Added: memoizing feature to parseconfig(); reduce repetitive process calls.
* Fixed: remove debug prints
* Updated: rewrite a tiket template generator
* Fixed: At the bitbucket, forgot to display a priority when updating a ticket.
* Fixed: At the Redmine, forgot to dicplay a status when updating a ticket.


v0.3
Initial release

------------
What's Next?
------------

* More tests
* Documentation
* git-flow integration

-------
License
-------

It is released under the MIT license.

Copyright (c) 2011 Hiroyuki Tanaka

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.