github3.core

Kenneth Reitz · Kenneth Reitz · commit 36bbb3980dad · 2011-12-26T22:47:06.000-05:00
diff --git a/github3/core.py b/github3/core.py
@@ -0,0 +1,20 @@
+# -*- coding: utf-8 -*-
+
+"""
+github3.core
+~~~~~~~~~~~~~
+
+This module provides the base entrypoint for github3.
+"""
+
+from .api import Github
+
+def from_key(username, password):
+    """Returns an authenticated Github instance, via API Key."""
+
+    gh = Github()
+
+    # Login.
+    gh.login(username, password)
+
+    return gh
