aboutsummaryrefslogtreecommitdiffstats
path: root/github3/core.py
blob: 725d09dd592cf2c84dfeb277b04e457be34f2621 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
# -*- coding: utf-8 -*-

"""
github3.core
~~~~~~~~~~~~

This module provides the entrance point for the GitHub3 module.
"""

__version__ = '0.0.0'
__license__ = 'MIT'
__author__ = 'Kenneth Reitz'

from .api import Github, settings


def no_auth():
    """Returns an un-authenticated Github object."""

    gh = Github()

    return gh


def basic_auth(username, password):
    """Returns an authenticated Github object, via HTTP Basic."""

    def enable_auth(*args, **kwargs):
        kwargs['auth'] = (username, password)
        return args, kwargs

    gh = Github()
    gh.is_authenticated = True
    gh._requests_pre_hook = enable_auth

    return gh