Merge pull request #510 from PyCQA/package-pycodestyle

Package pycodestyle

Author: sigmavirus24

.travis.yml

@@ -14,9 +14,9 @@ install:
   - pip install -e .
   - pip list
 script:
-  - python pep8.py --testsuite testsuite
-  - python pep8.py --statistics pep8.py
-  - python pep8.py --doctest
+  - python pycodestyle.py --testsuite testsuite
+  - python pycodestyle.py --statistics pycodestyle.py
+  - python pycodestyle.py --doctest
   - python setup.py test
 
 notifications:

Makefile

@@ -1,11 +1,11 @@
 test :
-	python pep8.py --testsuite testsuite
+	python pycodestyle.py --testsuite testsuite
 
 selftest :
-	python pep8.py --statistics pep8.py
+	python pycodestyle.py --statistics pycodestyle.py
 
 doctest :
-	python pep8.py --doctest
+	python pycodestyle.py --doctest
 
 unittest :
 	python -m testsuite.test_all

docs/advanced.rst

@@ -13,14 +13,14 @@ can be highly useful for automated testing of coding style conformance
 in your project::
 
   import unittest
-  import pep8
+  import pycodestyle
 
 
   class TestCodeFormat(unittest.TestCase):
 
       def test_pep8_conformance(self):
           """Test that we conform to PEP8."""
-          pep8style = pep8.StyleGuide(quiet=True)
+          pep8style = pycodestyle.StyleGuide(quiet=True)
           result = pep8style.check_files(['file1.py', 'file2.py'])
           self.assertEqual(result.total_errors, 0,
                            "Found code style errors (and warnings).")
@@ -30,9 +30,9 @@ since Nose suppresses stdout.
 
 There's also a shortcut for checking a single file::
 
-  import pep8
+  import pycodestyle
 
-  fchecker = pep8.Checker('testsuite/E27.py', show_source=True)
+  fchecker = pycodestyle.Checker('testsuite/E27.py', show_source=True)
   file_errors = fchecker.check_all()
 
   print("Found %s errors (and warnings)" % file_errors)
@@ -46,13 +46,13 @@ You can configure automated ``pep8`` tests in a variety of ways.
 For example, you can pass in a path to a configuration file that ``pep8``
 should use::
 
-  import pep8
+  import pycodestyle
 
-  pep8style = pep8.StyleGuide(config_file='/path/to/tox.ini')
+  pep8style = pycodestyle.StyleGuide(config_file='/path/to/tox.ini')
 
 You can also set specific options explicitly::
 
-  pep8style = pep8.StyleGuide(ignore=['E501'])
+  pep8style = pycodestyle.StyleGuide(ignore=['E501'])
 
 
 Skip file header
@@ -64,19 +64,19 @@ at the beginning and the end of a file.  This use case is easy to implement
 through a custom wrapper for the PEP 8 library::
 
   #!python
-  import pep8
+  import pycodestyle
 
   LINES_SLICE = slice(14, -20)
 
-  class PEP8(pep8.StyleGuide):
-      """This subclass of pep8.StyleGuide will skip the first and last lines
+  class PEP8(pycodestyle.StyleGuide):
+      """This subclass of pycodestyle.StyleGuide will skip the first and last lines
       of each file."""
 
       def input_file(self, filename, lines=None, expected=None, line_offset=0):
           if lines is None:
               assert line_offset == 0
               line_offset = LINES_SLICE.start or 0
-              lines = pep8.readlines(filename)[LINES_SLICE]
+              lines = pycodestyle.readlines(filename)[LINES_SLICE]
           return super(PEP8, self).input_file(
               filename, lines=lines, expected=expected, line_offset=line_offset)
 

pep8.py renamed to pycodestyle.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python
-# pep8.py - Check Python source code formatting, according to PEP 8
+# pycodestyle.py - Check Python source code formatting, according to PEP 8
+#
 # Copyright (C) 2006-2009 Johann C. Rocholl <johann@rocholl.net>
 # Copyright (C) 2009-2014 Florent Xicluna <florent.xicluna@gmail.com>
 # Copyright (C) 2014-2016 Ian Lee <ianlee1521@gmail.com>
@@ -28,7 +29,7 @@
 Check Python source code formatting, according to PEP 8.
 
 For usage and a list of options, try this:
-$ python pep8.py -h
+$ python pycodestyle.py -h
 
 This program and its regression test suite live here:
 https://github.com/pycqa/pycodestyle
@@ -2158,14 +2159,14 @@ def _main():
     except AttributeError:
         pass    # not supported on Windows
 
-    pep8style = StyleGuide(parse_argv=True)
-    options = pep8style.options
+    style_guide = StyleGuide(parse_argv=True)
+    options = style_guide.options
 
     if options.doctest or options.testsuite:
         from testsuite.support import run_tests
-        report = run_tests(pep8style)
+        report = run_tests(style_guide)
     else:
-        report = pep8style.check_files()
+        report = style_guide.check_files()
 
     if options.statistics:
         report.print_statistics()
@@ -2181,5 +2182,20 @@ def _main():
             sys.stderr.write(str(report.total_errors) + '\n')
         sys.exit(1)
 
+
+def _main_pep8():
+    """Entrypoint for pep8 commandline tool.
+
+    Warn of deprecation and advise users to switch to pycodestyle.
+    """
+    print(
+        'Deprecation Warning:\n'
+        'pep8 has been renamed to pycodestyle and the use of the pep8 '
+        'executable will be removed in a future release. Please use '
+        '`pycodestyle` instead.\n'
+    )
+    _main()
+
+
 if __name__ == '__main__':
     _main()

setup.py

@@ -4,7 +4,7 @@
 
 
 def get_version():
-    with open('pep8.py') as f:
+    with open('pycodestyle.py') as f:
         for line in f:
             if line.startswith('__version__'):
                 return eval(line.split('=')[-1])
@@ -19,16 +19,16 @@ def get_long_description():
 
 
 setup(
-    name='pep8',
+    name='pycodestyle',
     version=get_version(),
     description="Python style guide checker",
     long_description=get_long_description(),
-    keywords='pep8',
+    keywords='pycodestyle, pep8, PEP 8, PEP-8, PEP8',
     author='Johann C. Rocholl',
     author_email='johann@rocholl.net',
     url='http://pep8.readthedocs.org/',
     license='Expat license',
-    py_modules=['pep8'],
+    py_modules=['pycodestyle'],
     namespace_packages=[],
     include_package_data=True,
     zip_safe=False,
@@ -38,7 +38,8 @@ def get_long_description():
     ],
     entry_points={
         'console_scripts': [
-            'pep8 = pep8:_main',
+            'pycodestyle = pycodestyle:_main',
+            'pep8 = pycodestyle:_main_pep8',
         ],
     },
     classifiers=[

testsuite/support.py

@@ -3,7 +3,7 @@
 import re
 import sys
 
-from pep8 import Checker, BaseReport, StandardReport, readlines
+from pycodestyle import Checker, BaseReport, StandardReport, readlines
 
 SELFTEST_REGEX = re.compile(r'\b(Okay|[EW]\d{3}):\s(.*)')
 ROOT_DIR = os.path.dirname(os.path.dirname(__file__))
@@ -119,7 +119,7 @@ def selftest(options):
                     print("%s: %s" % (code, source))
             else:
                 count_failed += 1
-                print("pep8.py: %s:" % error)
+                print("pycodestyle.py: %s:" % error)
                 for line in checker.lines:
                     print(line.rstrip())
     return count_failed, count_all

testsuite/test_all.py

@@ -4,24 +4,26 @@
 import sys
 import unittest
 
-import pep8
+import pycodestyle
 from testsuite.support import init_tests, selftest, ROOT_DIR
 
 # Note: please only use a subset of unittest methods which were present
 # in Python 2.5: assert(True|False|Equal|NotEqual|Raises)
 
 
-class Pep8TestCase(unittest.TestCase):
+class PycodestyleTestCase(unittest.TestCase):
     """Test the standard errors and warnings (E and W)."""
 
     def setUp(self):
-        self._style = pep8.StyleGuide(
+        self._style = pycodestyle.StyleGuide(
             paths=[os.path.join(ROOT_DIR, 'testsuite')],
             select='E,W', quiet=True)
 
     def test_doctest(self):
         import doctest
-        fail_d, done_d = doctest.testmod(pep8, verbose=False, report=False)
+        fail_d, done_d = doctest.testmod(
+            pycodestyle, verbose=False, report=False
+        )
         self.assertTrue(done_d, msg='tests not found')
         self.assertFalse(fail_d, msg='%s failure(s)' % fail_d)
 
@@ -37,9 +39,9 @@ def test_checkers_testsuite(self):
                          msg='%s failure(s)' % report.total_errors)
 
     def test_own_dog_food(self):
-        files = [pep8.__file__.rstrip('oc'), __file__.rstrip('oc'),
+        files = [pycodestyle.__file__.rstrip('oc'), __file__.rstrip('oc'),
                  os.path.join(ROOT_DIR, 'setup.py')]
-        report = self._style.init_report(pep8.StandardReport)
+        report = self._style.init_report(pycodestyle.StandardReport)
         report = self._style.check_files(files)
         self.assertFalse(report.total_errors,
                          msg='Failures: %s' % report.messages)
@@ -49,7 +51,7 @@ def suite():
     from testsuite import test_api, test_parser, test_shell, test_util
 
     suite = unittest.TestSuite()
-    suite.addTest(unittest.makeSuite(Pep8TestCase))
+    suite.addTest(unittest.makeSuite(PycodestyleTestCase))
     suite.addTest(unittest.makeSuite(test_api.APITestCase))
     suite.addTest(unittest.makeSuite(test_parser.ParserTestCase))
     suite.addTest(unittest.makeSuite(test_shell.ShellTestCase))