Refactor - split to modules, add parser tests, update readme

README.rst

@@ -10,11 +10,6 @@ docstring conventions.
 `PEP 257 <http://www.python.org/dev/peps/pep-0257/>`_ out of the box, but it
 should not be considered a reference implementation.
 
-The framework for checking docstring style is flexible, and
-custom checks can be easily added, for example to cover
-NumPy `docstring conventions
-<https://github.com/numpy/numpy/blob/master/doc/HOWTO_DOCUMENT.rst.txt>`_.
-
 **pydocstyle** supports Python 2.6, 2.7, 3.3, 3.4, 3.5, pypy and pypy3.
 
 Quick Start
@@ -27,16 +22,19 @@ Install
 
     pip install pydocstyle
 
+
 Run
-^^^
+^^^^
 
 .. code::
 
     $ pydocstyle test.py
     test.py:18 in private nested class `meta`:
             D101: Docstring missing
-    test.py:22 in public method `method`:
-            D102: Docstring missing
+    test.py:27 in public function `get_user`:
+        D300: Use """triple double quotes""" (found '''-quotes)
+    test:75 in public function `init_database`:
+        D201: No blank lines allowed before function docstring (found 1)
     ...
 
 
@@ -50,7 +48,7 @@ Links
     :target: https://readthedocs.org/projects/pydocstyle/?badge=latest
     :alt: Documentation Status
 
-* `Read the full documentation here <https://pydocstyle.readthedocs.io>`_.
+* `Read the full documentation here <https://pydocstyle.org>`_.
 
 * `Fork pydocstyle on GitHub <https://github.com/PyCQA/pydocstyle>`_.
 

docs/conf.py

@@ -268,7 +268,7 @@
 
 
 def generate_error_code_table():
-    from pydocstyle import ErrorRegistry
+    from pydocstyle.violations import ErrorRegistry
     with open(os.path.join('snippets', 'error_code_table.rst'), 'wt') as outf:
         outf.write(ErrorRegistry.to_rst())
 

requirements.txt

@@ -1,2 +1,3 @@
 -r requirements/docs.txt
 -r requirements/tests.txt
+-r requirements/runtime.txt

requirements/tests.txt

@@ -1,4 +1,5 @@
 pytest==2.7.3
 pytest-pep8
 mock
-tox
+tox
+pathlib

setup.py

@@ -3,7 +3,9 @@
 from setuptools import setup
 
 
-with open(os.path.join('src', 'pydocstyle.py')) as f:
+this_dir = os.path.dirname(__file__)
+
+with open(os.path.join(this_dir, 'src', 'pydocstyle', 'utils.py')) as f:
     for line in f:
         if line.startswith('__version__'):
             version = eval(line.split('=')[-1])
@@ -27,12 +29,13 @@
         'License :: OSI Approved :: MIT License',
     ],
     keywords='pydocstyle, PEP 257, pep257, PEP 8, pep8, docstrings',
+    packages=('pydocstyle',),
+    py_modules=('main',),
     package_dir={'': 'src'},
-    py_modules=['pydocstyle'],
     entry_points={
         'console_scripts': [
-            'pydocstyle = pydocstyle:main',
-            'pep257 = pydocstyle:main_pep257',
+            'pydocstyle = pydocstyle.cli:main',
+            'pep257 = pydocstyle.cli:main_pep257',
         ],
     },
 )

src/main.py

@@ -0,0 +1,19 @@
+#! /usr/bin/env python
+"""Static analysis tool for checking docstring conventions and style.
+
+The repository is located at:
+https://github.com/PyCQA/pydocstyle
+
+"""
+
+
+__all__ = ()
+
+
+def main():
+    from pydocstyle import cli
+    cli.main()
+
+
+if __name__ == '__main__':
+    main()