Merge pull request #58 from pllim/lazy-import

Expose handler classes in top level import

.gitignore

@@ -7,3 +7,5 @@ htmlcov/
 *egg-info*
 build/
 dist/
+doc/api/
+doc/_build/

baldrick/__init__.py

@@ -1,16 +1,17 @@
-import os
-
-from flask import Flask
-from werkzeug.contrib.fixers import ProxyFix
-
-from baldrick.config import load, Config
-from baldrick.blueprints import github_blueprint, circleci_blueprint
+from baldrick import github  # noqa
 
 __all__ = ['create_app', '__version__']
 
 __version__ = '0.3.dev0'
 
-GLOBAL_TOML = os.path.join('.', 'pyproject.toml')
+GLOBAL_TOML = ''
+
+
+def _init_global_toml():
+    import os
+    global GLOBAL_TOML
+
+    GLOBAL_TOML = os.path.join('.', 'pyproject.toml')
 
 
 def create_app(name, register_blueprints=True):
@@ -31,6 +32,13 @@ def create_app(name, register_blueprints=True):
     app
 
     """
+    import os
+
+    from flask import Flask
+    from werkzeug.contrib.fixers import ProxyFix
+
+    from baldrick.config import load, Config
+    from baldrick.blueprints import github_blueprint, circleci_blueprint
 
     app = Flask(name)
 
@@ -60,3 +68,6 @@ def installation_authorized():
         return "Installation authorized"
 
     return app
+
+
+_init_global_toml()

baldrick/github/__init__.py

@@ -0,0 +1 @@
+from baldrick.github.github_api import *  # noqa

baldrick/github/github_api.py

@@ -12,7 +12,7 @@
 from baldrick.config import loads
 from baldrick.github.github_auth import github_request_headers
 
-__all__ = ['GitHubHandler', 'RepoHandler', 'PullRequestHandler']
+__all__ = ['GitHubHandler', 'IssueHandler', 'RepoHandler', 'PullRequestHandler']
 
 HOST = "https://api.github.com"
 HOST_NONAPI = "https://github.com"

doc/api.rst

@@ -1,7 +1,7 @@
 API documentation
 =================
 
-.. automodapi:: baldrick.github.github_api
+.. automodapi:: baldrick.github
    :no-inheritance-diagram:
 
 .. automodapi:: baldrick.github.github_auth

doc/local.rst

@@ -6,13 +6,13 @@ GitHub API
 
 The different components of the bot interact with GitHub via a set of helper
 classes that live in ``baldrick.github``. These classes are
-:class:`~baldrick.github.github_api.RepoHandler`,
-:class:`~baldrick.github.github_api.IssueHandler`, and
-:class:`~baldrick.github.github_api.PullRequestHandler`. It is possible to try
+:class:`~baldrick.github.RepoHandler`,
+:class:`~baldrick.github.IssueHandler`, and
+:class:`~baldrick.github.PullRequestHandler`. It is possible to try
 these out locally, at least for the parts of the GitHub API that do not require
 authentication. For example, the following should work::
 
-    >>> from baldrick.github.github_api import RepoHandler, IssueHandler, PullRequestHandler
+    >>> from baldrick.github import RepoHandler, IssueHandler, PullRequestHandler
     >>> repo = RepoHandler('astropy/astropy')
     >>> repo.get_issues('open', 'Close?')
     [6025, 5193, 4842, 4549, 4058, 3951, 3845, 2603, 2232, 1920, 1024, 435, 383, 282]
@@ -54,7 +54,7 @@ the Installation ID and look like:
 In this case, 36238 is the installation ID. Provided you set the environment
 variables correctly, you should then be able to do e.g.::
 
-    >>> from baldrick.github.github_api import IssueHandler
+    >>> from baldrick.github import IssueHandler
     >>> issue = IssueHandler('astrofrog/test-bot', 5, installation=36238)
     >>> issue.submit_comment('I am alive!')
 

doc/plugins.rst

@@ -118,8 +118,8 @@ then use it to decorate a function of the form::
         ...
 
 This function will be called with ``pr_handler``, an instance of
-:class:`~baldrick.github.github_api.PullRequestHandler`, and ``repo_handler``,
-an instance of :class:`~baldrick.github.github_api.RepoHandler` (click on
+:class:`~baldrick.github.PullRequestHandler`, and ``repo_handler``,
+an instance of :class:`~baldrick.github.RepoHandler` (click on
 the class names to find out the available properties/methods).
 
 Your function should then return either `None` (no check results), or