github2 0.6.2
GitHub API v2 library for Python.
License: BSD
Keywords: git github api

================================================================================
github2 - GitHub API v2 library for Python.
================================================================================

:Authors:
    Ask Solem (askh@opera.com)
:Version: 0.6.2

.. warning::

   GitHub have marked API v2 as deprecated, you should be looking to replace
   your usage of ``github2`` in the near future.

   Both remoteobjects_ and schematics_ provide easy-to-use functionality for
   creating bindings to remote APIs, and should significantly reduce the amount
   of work needed in moving away from GitHub's API v2.

This is a Python library implementing all of the features available in version 2
of the `GitHub API`_.

See the ``doc/`` directory for installation instructions and usage information.
If you prefer you can also read the `documentation online`_.

.. _remoteobjects: https://github.com/saymedia/remoteobjects
.. _schematics: http://pypi.python.org/pypi/schematics/
.. _GitHub API: http://develop.github.com/
.. _documentation online: http://packages.python.org/github2

License
=======

This software is licensed under the ``New BSD License``. See the ``LICENSE``
file in the top distribution directory for the full license text.

.. # vim: syntax=rst expandtab tabstop=4 shiftwidth=4 shiftround

User-visible changes
====================

This file lists only the most important changes that may be visible to users,
look at the `git repository`_ for the full project history.

.. _git repository: https://github.com/ask/python-github2/

0.6.2 - 2012-06-11
------------------

* Updated dependencies to handle recent ``python-dateutil`` releases
* Fixed ``simplejson`` dependencies for Python 2.4

0.6.1 - 2012-02-28
------------------

* Support for `GitHub:Enterprise`_ using the ``github_url`` parameter when
  creating a client
* Adds SSH key management
* Support reading SSL certificates from the location set in ``CURL_CA_BUNDLE``,
  if all else fails

.. _GitHub:Enterprise: https://enterprise.github.com/

0.6.0 - 2011-12-21
------------------

* Now uses system certificates for SSL validation where possible
* Python 3 is supported directly, without a separate ``2to3`` build step

0.5.2 - 2011-09-02
------------------

* Functions that returned `dict` objects have been deprecated, enable
  DeprecationWarning_ support to see if you're affected

.. _DeprecationWarning: http://docs.python.org/library/warnings.html

0.5.1 - 2011-06-11
------------------

* This is a bugfix release for compatibility with the latest httplib2_ release
* httplib2_ v0.7.0, or higher, is required

0.5.0 - 2011-05-24
------------------

* Support for `pull requests`_
* Simple logging_ based messages for event tracking and debugging
* Requires python-dateutil_

.. _pull requests: http://develop.github.com/p/pulls.html
.. _logging: http://docs.python.org/library/logging.html
.. _python-dateutil: http://pypi.python.org/pypi/python-dateutil

0.4.0 - 2011-05-23
------------------

* Python 3 compatibility
* The ``github_manage_collaborators`` script will be installed using
  ``entry_points``, which means there is now a run-time dependency on
  distribute_
* Support for managing `teams and organisations`_
* HTTP proxy support

.. _teams and organisations: http://develop.github.com/p/orgs.html
.. _distribute: http://pypi.python.org/pypi/distribute

0.3.0 - 2011-04-13
------------------

* Caching support, see the ``cache`` keyword of ``github.client.Github``
* OAuth2_ authentication support
* Additional ``issues`` support:

  + Searching issues with ``issues.search``
  + List issues by label with ``issues.list_by_label``
  + List all project labels with ``issues.list_labels``
  + Edit an existing issue with ``issues.edit``
  + Reopen closed issues with ``issues.reopen``

* Additional ``repos`` support

  + List non-owned projects that you have push rights to with ``repos.pushable``

* Requires httplib2_

.. _OAuth2: http://develop.github.com/p/oauth.html
.. _httplib2: http://code.google.com/p/httplib2/