From 107f595d13fda6c76ad2ea218359d11209b5d4a4 Mon Sep 17 00:00:00 2001
From: Ian Cordasco <graffatcolmingov@gmail.com>
Date: Wed, 8 Jun 2016 11:48:36 -0500
Subject: [PATCH] Add flake8.api and docs for it

Stub out the primary method people seem to use.
---
 docs/source/user/index.rst      |  1 +
 docs/source/user/python-api.rst | 11 +++++++++++
 flake8/api.py                   | 10 ++++++++++
 3 files changed, 22 insertions(+)
 create mode 100644 docs/source/user/python-api.rst
 create mode 100644 flake8/api.py

diff --git a/docs/source/user/index.rst b/docs/source/user/index.rst
index 5e7503f..2ed779e 100644
--- a/docs/source/user/index.rst
+++ b/docs/source/user/index.rst
@@ -24,6 +24,7 @@ This guide will cover all of these and the nuances for using Flake8.
     configuration
     options
     ignoring-errors
+    python-api
 
 .. config files
 .. command-line tutorial
diff --git a/docs/source/user/python-api.rst b/docs/source/user/python-api.rst
new file mode 100644
index 0000000..2e2a16e
--- /dev/null
+++ b/docs/source/user/python-api.rst
@@ -0,0 +1,11 @@
+===================
+ Public Python API
+===================
+
+Flake8 3.0.0 presently does not have a public, stable Python API.
+
+When it does it will be located in :mod:`flake8.api` and that will
+be documented here.
+
+.. automodule:: flake8.api
+    :members:
diff --git a/flake8/api.py b/flake8/api.py
new file mode 100644
index 0000000..9f95557
--- /dev/null
+++ b/flake8/api.py
@@ -0,0 +1,10 @@
+"""Module containing all public entry-points for Flake8.
+
+This is the only submodule in Flake8 with a guaranteed stable API. All other
+submodules are considered internal only and are subject to change.
+"""
+
+
+def get_style_guide(**kwargs):
+    """Stub out the only function I'm aware of people using."""
+    pass