# -*- coding: utf-8 -*-

"""

github3.github

==============

This module contains the main GitHub session object.

"""

from __future__ import unicode_literals

import json

from .auths import Authorization

from .decorators import (requires_auth, requires_basic_auth,

requires_app_credentials)

from .events import Event

from .gists import Gist

from .issues import ShortIssue, Issue, issue_params

from .models import GitHubCore

from .orgs import Membership, ShortOrganization, Organization, Team

from .projects import Project, ProjectCard, ProjectColumn

from .pulls import PullRequest

from .repos import repo

from .search import (CodeSearchResult, IssueSearchResult,

RepositorySearchResult, UserSearchResult)

from .structs import SearchIterator

from . import users

from .notifications import Thread

from .licenses import License

from uritemplate import URITemplate

class GitHub(GitHubCore):

"""Stores all the session information.

There are two ways to log into the GitHub API

::

from github3 import login

g = login(user, password)

g = login(token=token)

g = login(user, token=token)

or

::

from github3 import GitHub

g = GitHub(user, password)

g = GitHub(token=token)

g = GitHub(user, token=token)

This is simple backward compatibility since originally there was no way to

call the GitHub object with authentication parameters.

"""

def __init__(self, username='', password='', token=''):

super(GitHub, self).__init__({})

if token:

self.login(username, token=token)

elif username and password:

self.login(username, password)

def _repr(self):

if self.session.auth:

return '<GitHub [{0[0]}]>'.format(self.session.auth)

return '<GitHub at 0x{0:x}>'.format(id(self))

@requires_auth

def add_email_addresses(self, addresses=[]):

"""Add the email addresses in ``addresses`` to the authenticated

user's account.

:param list addresses: (optional), email addresses to be added

:returns: list of :class:`~github3.users.Email`

"""

json = []

if addresses:

url = self._build_url('user', 'emails')

json = self._json(self._post(url, data=addresses), 201)

return [users.Email(email) for email in json] if json else []

def all_events(self, number=-1, etag=None):

"""Iterate over public events.

:param int number: (optional), number of events to return. Default: -1

returns all available events

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Event <github3.events.Event>`\ s

"""

url = self._build_url('events')

return self._iter(int(number), url, Event, etag=etag)

def all_organizations(self, number=-1, since=None, etag=None,

per_page=None):

"""Iterate over every organization in the order they were created.

:param int number: (optional), number of organizations to return.

Default: -1, returns all of them

:param int since: (optional), last organization id seen (allows

restarting this iteration)

:param str etag: (optional), ETag from a previous request to the same

endpoint

:param int per_page: (optional), number of organizations to list per

request

:returns: generator of :class:`ShortOrganization

<github3.orgs.ShortOrganization>`

"""

url = self._build_url('organizations')

return self._iter(int(number), url, ShortOrganization,

params={'since': since, 'per_page': per_page},

etag=etag)

def all_repositories(self, number=-1, since=None, etag=None,

per_page=None):

"""Iterate over every repository in the order they were created.

:param int number: (optional), number of repositories to return.

Default: -1, returns all of them

:param int since: (optional), last repository id seen (allows

restarting this iteration)

:param str etag: (optional), ETag from a previous request to the same

endpoint

:param int per_page: (optional), number of repositories to list per

request

:returns: generator of :class:`~github3.repos.ShortRepository`

"""

url = self._build_url('repositories')

return self._iter(int(number), url, repo.ShortRepository,

params={'since': since, 'per_page': per_page},

etag=etag)

def all_users(self, number=-1, etag=None, per_page=None, since=None):

"""Iterate over every user in the order they signed up for GitHub.

.. versionchanged:: 1.0.0

Inserted the ``since`` parameter after the ``number`` parameter.

:param int number: (optional), number of users to return. Default: -1,

returns all of them

:param int since: (optional), ID of the last user that you've seen.

:param str etag: (optional), ETag from a previous request to the same

endpoint

:param int per_page: (optional), number of users to list per request

:returns: generator of :class:`~github3.users.ShortUser`

"""

url = self._build_url('users')

return self._iter(int(number), url, users.ShortUser, etag=etag,

params={'per_page': per_page, 'since': since})

@requires_basic_auth

def authorization(self, id_num):

"""Get information about authorization ``id``.

:param int id_num: (required), unique id of the authorization

:returns: :class:`Authorization <Authorization>`

"""

json = None

if int(id_num) > 0:

url = self._build_url('authorizations', str(id_num))

json = self._json(self._get(url), 200)

return self._instance_or_null(Authorization, json)

@requires_basic_auth

def authorizations(self, number=-1, etag=None):

"""Iterate over authorizations for the authenticated user. This will

return a 404 if you are using a token for authentication.

:param int number: (optional), number of authorizations to return.

Default: -1 returns all available authorizations

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Authorization <Authorization>`\ s

"""

url = self._build_url('authorizations')

return self._iter(int(number), url, Authorization, etag=etag)

def authorize(self, username, password, scopes=None, note='', note_url='',

client_id='', client_secret=''):

"""Obtain an authorization token.

The retrieved token will allow future consumers to use the API without

a username and password.

:param str username: (required)

:param str password: (required)

:param list scopes: (optional), areas you want this token to apply to,

i.e., 'gist', 'user'

:param str note: (optional), note about the authorization

:param str note_url: (optional), url for the application

:param str client_id: (optional), 20 character OAuth client key for

which to create a token

:param str client_secret: (optional), 40 character OAuth client secret

for which to create the token

:returns: :class:`Authorization <Authorization>`

"""

json = None

if username and password:

url = self._build_url('authorizations')

data = {'note': note, 'note_url': note_url,

'client_id': client_id, 'client_secret': client_secret}

if scopes:

data['scopes'] = scopes

with self.session.temporary_basic_auth(username, password):

json = self._json(self._post(url, data=data), 201)

return self._instance_or_null(Authorization, json)

def check_authorization(self, access_token):

"""Check an authorization created by a registered application.

OAuth applications can use this method to check token validity

without hitting normal rate limits because of failed login attempts.

If the token is valid, it will return True, otherwise it will return

False.

:returns: bool

"""

p = self.session.params

auth = (p.get('client_id'), p.get('client_secret'))

if access_token and auth:

url = self._build_url('applications', str(auth[0]), 'tokens',

str(access_token))

resp = self._get(url, auth=auth, params={

'client_id': None, 'client_secret': None

})

return self._boolean(resp, 200, 404)

return False

def create_gist(self, description, files, public=True):

"""Create a new gist.

If no login was provided, it will be anonymous.

:param str description: (required), description of gist

:param dict files: (required), file names with associated dictionaries

for content, e.g. ``{'spam.txt': {'content': 'File contents

...'}}``

:param bool public: (optional), make the gist public if True

:returns: :class:`Gist <github3.gists.Gist>`

"""

new_gist = {'description': description, 'public': public,

'files': files}

url = self._build_url('gists')

json = self._json(self._post(url, data=new_gist), 201)

return self._instance_or_null(Gist, json)

@requires_auth

def create_issue(self, owner, repository, title, body=None, assignee=None,

milestone=None, labels=[], assignees=None):

"""Create an issue on the project 'repository' owned by 'owner'

with title 'title'.

``body``, ``assignee``, ``assignees``, ``milestone``, ``labels``

are all optional.

.. warning::

This method retrieves the repository first and then uses it to

create an issue. If you're making several issues, you should use

:py:meth:`repository <github3.github.GitHub.repository>` and then

use :py:meth:`create_issue

<github3.repos.repo.Repository.create_issue>`

:param str owner: (required), login of the owner

:param str repository: (required), repository name

:param str title: (required), Title of issue to be created

:param str body: (optional), The text of the issue, markdown

formatted

:param str assignee: (optional), Login of person to assign

the issue to

:param assignees: (optional), logins of the users to assign the

issue to

:param int milestone: (optional), id number of the milestone to

attribute this issue to (e.g. ``m`` is a :class:`Milestone

<github3.issues.Milestone>` object, ``m.number`` is what you pass

here.)

:param list labels: (optional), List of label names.

:returns: :class:`ShortIssue <github3.issues.ShortIssue>` if

successful

"""

repo = None

if owner and repository and title:

repo = self.repository(owner, repository)

if repo is not None:

return repo.create_issue(title, body, assignee, milestone,

labels, assignees)

return self._instance_or_null(ShortIssue, None)

@requires_auth

def create_key(self, title, key, read_only=False):

"""Create a new key for the authenticated user.

:param str title: (required), key title

:param str key: (required), actual key contents, accepts path

as a string or file-like object

:param bool read_only: (optional), restrict key access to read-only,

default to False

:returns: :class:`Key <github3.users.Key>`

"""

json = None

if title and key:

data = {'title': title, 'key': key, 'read_only': read_only}

url = self._build_url('user', 'keys')

req = self._post(url, data=data)

json = self._json(req, 201)

return self._instance_or_null(users.Key, json)

@requires_auth

def create_repository(self, name, description='', homepage='',

private=False, has_issues=True, has_wiki=True,

auto_init=False, gitignore_template=''):

"""Create a repository for the authenticated user.

:param str name: (required), name of the repository

:param str description: (optional)

:param str homepage: (optional)

:param str private: (optional), If ``True``, create a

private repository. API default: ``False``

:param bool has_issues: (optional), If ``True``, enable

issues for this repository. API default: ``True``

:param bool has_wiki: (optional), If ``True``, enable the

wiki for this repository. API default: ``True``

:param bool auto_init: (optional), auto initialize the repository

:param str gitignore_template: (optional), name of the git template to

use; ignored if auto_init = False.

:returns: :class:`Repository <github3.repos.Repository>`

.. warning: ``name`` should be no longer than 100 characters

"""

url = self._build_url('user', 'repos')

data = {'name': name, 'description': description,

'homepage': homepage, 'private': private,

'has_issues': has_issues, 'has_wiki': has_wiki,

'auto_init': auto_init,

'gitignore_template': gitignore_template}

json = self._json(self._post(url, data=data), 201)

return self._instance_or_null(repo.Repository, json)

@requires_auth

def delete_email_addresses(self, addresses=[]):

"""Delete the email addresses in ``addresses`` from the

authenticated user's account.

:param list addresses: (optional), email addresses to be removed

:returns: bool

"""

url = self._build_url('user', 'emails')

return self._boolean(self._delete(url, data=json.dumps(addresses)),

204, 404)

@requires_auth

def emails(self, number=-1, etag=None):

"""Iterate over email addresses for the authenticated user.

:param int number: (optional), number of email addresses to return.

Default: -1 returns all available email addresses

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of dicts

"""

url = self._build_url('user', 'emails')

return self._iter(int(number), url, users.Email, etag=etag)

def emojis(self):

"""Retrieves a dictionary of all of the emojis that GitHub supports.

:returns: dictionary where the key is what would be in between the

colons and the value is the URL to the image, e.g., ::

{

'+1': 'https://github.global.ssl.fastly.net/images/...',

# ...

}

"""

url = self._build_url('emojis')

return self._json(self._get(url), 200, include_cache_info=False)

@requires_basic_auth

def feeds(self):

"""List GitHub's timeline resources in Atom format.

:returns: dictionary parsed to include URITemplates

"""

def replace_href(feed_dict):

if not feed_dict:

return feed_dict

ret_dict = {}

# Let's pluck out what we're most interested in, the href value

href = feed_dict.pop('href', None)

# Then we update the return dictionary with the rest of the values

ret_dict.update(feed_dict)

if href is not None:

# So long as there is something to template, let's template it

ret_dict['href'] = URITemplate(href)

return ret_dict

url = self._build_url('feeds')

json = self._json(self._get(url), 200, include_cache_info=False)

if json is None: # If something went wrong, get out early

return None

# We have a response body to parse

feeds = {}

# Let's pop out the old links so we don't have to skip them below

old_links = json.pop('_links', {})

_links = {}

# If _links is in the response JSON, iterate over that and recreate it

# so that any templates contained inside can be turned into

# URITemplates

for key, value in old_links.items():

if isinstance(value, list):

# If it's an array/list of links, let's replace that with a

# new list of links

_links[key] = [replace_href(d) for d in value]

else:

# Otherwise, just use the new value

_links[key] = replace_href(value)

# Start building up our return dictionary

feeds['_links'] = _links

for key, value in json.items():

# This should roughly be the same logic as above.

if isinstance(value, list):

feeds[key] = [URITemplate(v) for v in value]

else:

feeds[key] = URITemplate(value)

return feeds

@requires_auth

def follow(self, username):

"""Make the authenticated user follow the provided username.

:param str username: (required), user to follow

:returns: bool

"""

resp = False

if username:

url = self._build_url('user', 'following', username)

resp = self._boolean(self._put(url), 204, 404)

return resp

def followed_by(self, username, number=-1, etag=None):

r"""Iterate over users being followed by ``username``.

.. versionadded:: 1.0.0

This replaces iter_following('sigmavirus24').

:param str username: (required), login of the user to check

:param int number: (optional), number of people to return. Default: -1

returns all people you follow

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`~github3.users.ShortUser`\ s

"""

url = self._build_url('users', username, 'following')

return self._iter(int(number), url, users.ShortUser, etag=etag)

@requires_auth

def followers(self, number=-1, etag=None):

r"""Iterate over followers of the authenticated user.

.. versionadded:: 1.0.0

This replaces iter_followers().

:param int number: (optional), number of followers to return. Default:

-1 returns all followers

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`~github3.users.ShortUser`\ s

"""

url = self._build_url('user', 'followers')

return self._iter(int(number), url, users.ShortUser, etag=etag)

def followers_of(self, username, number=-1, etag=None):

r"""Iterate over followers of ``username``.

.. versionadded:: 1.0.0

This replaces iter_followers('sigmavirus24').

:param str username: (required), login of the user to check

:param int number: (optional), number of followers to return. Default:

-1 returns all followers

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`~github3.users.ShortUser`\ s

"""

url = self._build_url('users', username, 'followers')

return self._iter(int(number), url, users.ShortUser, etag=etag)

@requires_auth

def following(self, number=-1, etag=None):

r"""Iterate over users the authenticated user is following.

.. versionadded:: 1.0.0

This replaces iter_following().

:param int number: (optional), number of people to return. Default: -1

returns all people you follow

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`~github3.users.ShortUser`\ s

"""

url = self._build_url('user', 'following')

return self._iter(int(number), url, users.ShortUser, etag=etag)

def gist(self, id_num):

"""Retrieve the gist using the specified id number.

:param int id_num: (required), unique id of the gist

:returns: :class:`Gist <github3.gists.Gist>`

"""

url = self._build_url('gists', str(id_num))

json = self._json(self._get(url), 200)

return self._instance_or_null(Gist, json)

@requires_auth

def gists(self, number=-1, etag=None):

"""Retrieve the authenticated user's gists.

.. versionadded:: 1.0

:param int number: (optional), number of gists to return. Default: -1,

returns all available gists

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Gist <github3.gists.Gist>`\ s

"""

url = self._build_url('gists')

return self._iter(int(number), url, Gist, etag=etag)

def gists_by(self, username, number=-1, etag=None):

"""Iterate over the gists owned by a user.

.. versionadded:: 1.0

:param str username: login of the user who owns the gists

:param int number: (optional), number of gists to return. Default: -1

returns all available gists

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Gist <github3.gists.Gist>`\ s

"""

url = self._build_url('users', username, 'gists')

return self._iter(int(number), url, Gist, etag=etag)

def gitignore_template(self, language):

"""Return the template for language.

:returns: str

"""

url = self._build_url('gitignore', 'templates', language)

json = self._json(self._get(url), 200)

if not json:

return ''

return json.get('source', '')

def gitignore_templates(self):

"""Return the list of available templates.

:returns: list of template names

"""

url = self._build_url('gitignore', 'templates')

return self._json(self._get(url), 200) or []

@requires_auth

def is_following(self, username):

"""Check if the authenticated user is following login.

:param str username: (required), login of the user to check if the

authenticated user is checking

:returns: bool

"""

json = False

if username:

url = self._build_url('user', 'following', username)

json = self._boolean(self._get(url), 204, 404)

return json

@requires_auth

def is_starred(self, username, repo):

"""Check if the authenticated user starred username/repo.

:param str username: (required), owner of repository

:param str repo: (required), name of repository

:returns: bool

"""

json = False

if username and repo:

url = self._build_url('user', 'starred', username, repo)

json = self._boolean(self._get(url), 204, 404)

return json

def issue(self, username, repository, number):

"""Fetch issue from owner/repository.

:param str username: (required), owner of the repository

:param str repository: (required), name of the repository

:param int number: (required), issue number

:return: :class:`Issue <github3.issues.Issue>`

"""

json = None

if username and repository and int(number) > 0:

url = self._build_url('repos', username, repository, 'issues',

str(number))

json = self._json(self._get(url), 200)

return self._instance_or_null(Issue, json)

@requires_auth

def issues(self, filter='', state='', labels='', sort='', direction='',

since=None, number=-1, etag=None):

"""List all of the authenticated user's (and organization's) issues.

.. versionchanged:: 0.9.0

- The ``state`` parameter now accepts 'all' in addition to 'open'

and 'closed'.

:param str filter: accepted values:

('assigned', 'created', 'mentioned', 'subscribed')

api-default: 'assigned'

:param str state: accepted values: ('all', 'open', 'closed')

api-default: 'open'

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return.

Default: -1 returns all issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`ShortIssue <github3.issues.ShortIssue>`

"""

url = self._build_url('issues')

# issue_params will handle the since parameter

params = issue_params(filter, state, labels, sort, direction, since)

return self._iter(int(number), url, ShortIssue, params, etag)

def issues_on(self, username, repository, milestone=None, state=None,

assignee=None, mentioned=None, labels=None, sort=None,

direction=None, since=None, number=-1, etag=None):

"""List issues on owner/repository. Only owner and repository are

required.

.. versionchanged:: 0.9.0

- The ``state`` parameter now accepts 'all' in addition to 'open'

and 'closed'.

:param str username: login of the owner of the repository

:param str repository: name of the repository

:param int milestone: None, '*', or ID of milestone

:param str state: accepted values: ('all', 'open', 'closed')

api-default: 'open'

:param str assignee: '*' or login of the user

:param str mentioned: login of the user

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return.

Default: -1 returns all issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`ShortIssue <github3.issues.ShortIssue>`\ s

"""

if username and repository:

url = self._build_url('repos', username, repository, 'issues')

params = repo.repo_issue_params(

milestone, state, assignee, mentioned,

labels, sort, direction, since,

)

return self._iter(int(number), url, ShortIssue, params=params,

etag=etag)

return iter([])

@requires_auth

def key(self, id_num):

"""Gets the authenticated user's key specified by id_num.

:param int id_num: (required), unique id of the key

:returns: :class:`Key <github3.users.Key>`

"""

json = None

if int(id_num) > 0:

url = self._build_url('user', 'keys', str(id_num))

json = self._json(self._get(url), 200)

return self._instance_or_null(users.Key, json)

@requires_auth

def keys(self, number=-1, etag=None):

"""Iterate over public keys for the authenticated user.

:param int number: (optional), number of keys to return. Default: -1

returns all your keys

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`Key <github3.users.Key>`\ s

"""

url = self._build_url('user', 'keys')

return self._iter(int(number), url, users.Key, etag=etag)

def license(self, name):

"""Retrieve the license specified by the name.

:param string name: (required), name of license

:returns: :class:`License <github3.licenses.License>`

"""

url = self._build_url('licenses', name)

json = self._json(self._get(url, headers=License.CUSTOM_HEADERS), 200)

return self._instance_or_null(License, json)

def licenses(self, number=-1, etag=None):

"""Iterate over open source licenses.

:returns: generator of :class:`License <github3.licenses.License>`

"""

url = self._build_url('licenses')

return self._iter(int(number), url, License, etag=etag,

headers=License.CUSTOM_HEADERS)

def login(self, username=None, password=None, token=None,

two_factor_callback=None):

"""Logs the user into GitHub for protected API calls.

:param str username: login name

:param str password: password for the login

:param str token: OAuth token

:param func two_factor_callback: (optional), function you implement to

provide the Two Factor Authentication code to GitHub when necessary

"""

if username and password:

self.session.basic_auth(username, password)

elif token:

self.session.token_auth(token)

# The Session method handles None for free.

self.session.two_factor_auth_callback(two_factor_callback)

def markdown(self, text, mode='', context='', raw=False):

"""Render an arbitrary markdown document.

:param str text: (required), the text of the document to render

:param str mode: (optional), 'markdown' or 'gfm'

:param str context: (optional), only important when using mode 'gfm',

this is the repository to use as the context for the rendering

:param bool raw: (optional), renders a document like a README.md, no

gfm, no context

:returns: str (or unicode on Python 2) -- HTML formatted text

"""

data = None

json = False

headers = {}

if raw:

url = self._build_url('markdown', 'raw')

data = text

headers['content-type'] = 'text/plain'

else:

url = self._build_url('markdown')

data = {}

if text:

data['text'] = text

if mode in ('markdown', 'gfm'):

data['mode'] = mode

if context:

data['context'] = context

json = True

html = ''

if data:

req = self._post(url, data=data, json=json, headers=headers)

if req.ok:

html = req.text

return html

@requires_auth

def me(self):

"""Retrieve the info for the authenticated user.

.. versionadded:: 1.0

This was separated from the ``user`` method.

:returns: The representation of the authenticated user.

:rtype: :class:`~github3.users.AuthenticatedUser`

"""

url = self._build_url('user')

json = self._json(self._get(url), 200)

return self._instance_or_null(users.AuthenticatedUser, json)

@requires_auth

def membership_in(self, organization):

"""Retrieve the user's membership in the specified organization."""

url = self._build_url('user', 'memberships', 'orgs',

str(organization))

json = self._json(self._get(url), 200)

return self._instance_or_null(Membership, json)

def meta(self):

"""Returns a dictionary with arrays of addresses in CIDR format

specifying theaddresses that the incoming service hooks will originate

from.

.. versionadded:: 0.5

"""

url = self._build_url('meta')

return self._json(self._get(url), 200) or {}

@requires_auth

def notifications(self, all=False, participating=False, number=-1,

etag=None):

"""Iterate over the user's notification.

:param bool all: (optional), iterate over all notifications

:param bool participating: (optional), only iterate over notifications

in which the user is participating

:param int number: (optional), how many notifications to return

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`Thread <github3.notifications.Thread>`

"""

params = None

if all is True:

params = {'all': 'true'}

elif participating is True:

params = {'participating': 'true'}

url = self._build_url('notifications')

return self._iter(int(number), url, Thread, params, etag=etag)

def octocat(self, say=None):

"""Returns an easter egg of the API.

:params str say: (optional), pass in what you'd like Octocat to say

:returns: ascii art of Octocat

:rtype: str (or unicode on Python 3)

"""

url = self._build_url('octocat')

req = self._get(url, params={'s': say})

return req.text if req.ok else ''

def organization(self, username):

"""Returns a Organization object for the login name

:param str username: (required), login name of the org

:returns: :class:`Organization <github3.orgs.Organization>`

"""

url = self._build_url('orgs', username)

json = self._json(self._get(url), 200)

return self._instance_or_null(Organization, json)

@requires_auth

def organization_issues(self, name, filter='', state='', labels='',

sort='', direction='', since=None, number=-1,

etag=None):

"""Iterate over the organization's issues if the authenticated user

belongs to it.

:param str name: (required), name of the organization

:param str filter: accepted values:

('assigned', 'created', 'mentioned', 'subscribed')

api-default: 'assigned'

:param str state: accepted values: ('open', 'closed')

api-default: 'open'

:param str labels: comma-separated list of label names, e.g.,

'bug,ui,@high'

:param str sort: accepted values: ('created', 'updated', 'comments')

api-default: created

:param str direction: accepted values: ('asc', 'desc')

api-default: desc

:param since: (optional), Only issues after this date will

be returned. This can be a `datetime` or an ISO8601 formatted

date string, e.g., 2012-05-20T23:10:27Z

:type since: datetime or string

:param int number: (optional), number of issues to return. Default:

-1, returns all available issues

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of :class:`ShortIssue <github3.issues.ShortIssue>`

"""

url = self._build_url('orgs', name, 'issues')

# issue_params will handle the since parameter

params = issue_params(filter, state, labels, sort, direction, since)

return self._iter(int(number), url, ShortIssue, params, etag)

@requires_auth

def organizations(self, number=-1, etag=None):

"""Iterate over all organizations the authenticated user belongs to.

This will display both the private memberships and the publicized

memberships.

:param int number: (optional), number of organizations to return.

Default: -1 returns all available organizations

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`ShortOrganization <github3.orgs.ShortOrganization>`\ s

"""

url = self._build_url('user', 'orgs')

return self._iter(int(number), url, ShortOrganization, etag=etag)

def organizations_with(self, username, number=-1, etag=None):

"""Iterate over organizations with ``username`` as a public member.

.. versionadded:: 1.0.0

Replaces ``iter_orgs('sigmavirus24')``.

:param str username: (optional), user whose orgs you wish to list

:param int number: (optional), number of organizations to return.

Default: -1 returns all available organizations

:param str etag: (optional), ETag from a previous request to the same

endpoint

:returns: generator of

:class:`ShortOrganization <github3.orgs.ShortOrganization>`\ s

"""

if username:

url = self._build_url('users', username, 'orgs')

return self._iter(int(number), url, ShortOrganization, etag=etag)

return iter([])

def project(self, number):

"""Return the Project with id ``number``.

:param int number: id of the project

:returns: :class:`Project <github3.projects.Project>`

"""

number = int(number)

json = None

if number > 0:

url = self._build_url('projects', str(number))

json = self._json(self._get(

url, headers=Project.CUSTOM_HEADERS), 200)

return self._instance_or_null(Project, json)

def project_card(self, number):

"""Return the ProjectCard with id ``number``.

:param int number: id of the project card

:returns: :class:`ProjectCard <github3.projects.ProjectCard>`

"""

number = int(number)

json = None

if number > 0:

url = self._build_url('projects', 'columns', 'cards', str(number))

json = self._json(self._get(

url, headers=Project.CUSTOM_HEADERS), 200)

return self._instance_or_null(ProjectCard, json)

def project_column(self, number):

"""Return the ProjectColumn with id ``number``.

:param int number: id of the project column

:returns: :class:`ProjectColumn <github3.projects.ProjectColumn>`

"""

number = int(number)

json = None

if number > 0:

url = self._build_url('projects', 'columns', str(number))

json = self._json(self._get(

url, headers=Project.CUSTOM_HEADERS), 200)

return self._instance_or_null(ProjectColumn, json)

def public_gists(self, number=-1, etag=None):