.. Copyright (C) 2011-2012 James Rowe <jnrowe@gmail.com>

   This file is part of python-github2, is licensed under the 3-clause BSD
   License.  See the LICENSE file in the top distribution directory for the full
   license text.

.. module:: github2.repositories

Repository
==========

.. note::

   See the official GitHub API v2 documentation for `repositories`_.

.. _repositories: http://develop.github.com/p/repo.html

.. autoclass:: Repository(type)

.. autoclass:: Repositories(type)

Examples
--------

Searching Repositories
''''''''''''''''''''''

    >>> repositories = github.repos.search("django")


Show Repo Info
''''''''''''''

    >>> repo = github.repos.show("schacon/grit")
    >>> repo.homepage
    "http://grit.rubyforge.org/"

List All Repositories
'''''''''''''''''''''

    >>> repos = github.repos.list("schacon")

By default the first page of results is returned, you can return further results
with the ``page`` parameter:

    >>> repos = github.repos.list("schacon", page=2)

Watching Repositories
'''''''''''''''''''''

    >>> github.repos.watch("schacon/grit")

    >>> github.repos.unwatch("schacon/grit")

Forking Repositories
''''''''''''''''''''

    >>> fork = github.repos.fork("schacon/grit")

Creating and Deleting Repositories
''''''''''''''''''''''''''''''''''

    >>> new_repo = github.repos.create(name, description, homepage,
    ...                                 public=True)

    >>> github.repos.delete(name)

Repository Visibility
'''''''''''''''''''''

    >>> github.repos.set_private("ask/chishop")

    >>> github.repos.set_public("ask/chishop")

Pushable repositories
'''''''''''''''''''''

    >>> pushables = github.repos.pushable()

Collaborators
'''''''''''''

    >>> collabs = github.repos.list_collaborators("ask/chishop")

    >>> github.repos.add_collaborator("ask/chishop", "schacon")

    >>> github.repos.remove_collaborator("ask/chishop", "schacon")

Watchers
''''''''

    >>> watchers = github.repos.watchers("ask/chishop")


Network
'''''''

    >>> github.repos.network("ask/chishop")

Repository Refs
'''''''''''''''

Get a list of tags

    >>> tags = github.repos.tags("ask/chishop")

Get a list of remote branches

    >>> branches = github.repos.branches("ask/chishop")