From 5d76f1c0c5ab047a36bb2fbee6683cf487387ac2 Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:49:01 +0100
Subject: [PATCH 1/7] apply setup-py-upgrade

---
 setup.cfg | 17 +++++++++++++++++
 setup.py  | 27 ++-------------------------
 2 files changed, 19 insertions(+), 25 deletions(-)
 create mode 100644 setup.cfg

diff --git a/setup.cfg b/setup.cfg
new file mode 100644
index 0000000..e3a0546
--- /dev/null
+++ b/setup.cfg
@@ -0,0 +1,17 @@
+[metadata]
+name = sample
+version = 0.1.0
+description = Sample package for Python-Guide.org
+long_description = file: README.rst
+author = Kenneth Reitz
+author_email = me@kennethreitz.com
+url = https://github.com/kennethreitz/samplemod
+license = file: LICENSE
+
+[options]
+packages = find:
+
+[options.packages.find]
+exclude =
+    tests
+    docs
diff --git a/setup.py b/setup.py
index 12af806..8bf1ba9 100755
--- a/setup.py
+++ b/setup.py
@@ -1,25 +1,2 @@
-# -*- coding: utf-8 -*-
-
-# Learn more: https://github.com/kennethreitz/setup.py
-
-from setuptools import setup, find_packages
-
-
-with open('README.rst') as f:
-    readme = f.read()
-
-with open('LICENSE') as f:
-    license = f.read()
-
-setup(
-    name='sample',
-    version='0.1.0',
-    description='Sample package for Python-Guide.org',
-    long_description=readme,
-    author='Kenneth Reitz',
-    author_email='me@kennethreitz.com',
-    url='https://github.com/kennethreitz/samplemod',
-    license=license,
-    packages=find_packages(exclude=('tests', 'docs'))
-)
-
+from setuptools import setup
+setup()

From b2276b850ce933e64ffb21276d5532845ac547ff Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:49:20 +0100
Subject: [PATCH 2/7] fade to black

---
 docs/conf.py           | 136 ++++++++++++++++++++---------------------
 sample/__init__.py     |   2 +-
 sample/core.py         |   3 +-
 setup.py               |   1 +
 tests/context.py       |   3 +-
 tests/test_advanced.py |   2 +-
 tests/test_basic.py    |   4 +-
 7 files changed, 77 insertions(+), 74 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index ac03bd0..2ae8559 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -16,209 +16,203 @@
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
 # documentation root, use os.path.abspath to make it absolute, like shown here.
-#sys.path.insert(0, os.path.abspath('.'))
+# sys.path.insert(0, os.path.abspath('.'))
 
 # -- General configuration -----------------------------------------------------
 
 # If your documentation needs a minimal Sphinx version, state it here.
-#needs_sphinx = '1.0'
+# needs_sphinx = '1.0'
 
 # Add any Sphinx extension module names here, as strings. They can be extensions
 # coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
 extensions = []
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = ["_templates"]
 
 # The suffix of source filenames.
-source_suffix = '.rst'
+source_suffix = ".rst"
 
 # The encoding of source files.
-#source_encoding = 'utf-8-sig'
+# source_encoding = 'utf-8-sig'
 
 # The master toctree document.
-master_doc = 'index'
+master_doc = "index"
 
 # General information about the project.
-project = u'sample'
-copyright = u'2012, Kenneth Reitz'
+project = u"sample"
+copyright = u"2012, Kenneth Reitz"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
 # built documents.
 #
 # The short X.Y version.
-version = 'v0.0.1'
+version = "v0.0.1"
 # The full version, including alpha/beta/rc tags.
-release = 'v0.0.1'
+release = "v0.0.1"
 
 # The language for content autogenerated by Sphinx. Refer to documentation
 # for a list of supported languages.
-#language = None
+# language = None
 
 # There are two options for replacing |today|: either, you set today to some
 # non-false value, then it is used:
-#today = ''
+# today = ''
 # Else, today_fmt is used as the format for a strftime call.
-#today_fmt = '%B %d, %Y'
+# today_fmt = '%B %d, %Y'
 
 # List of patterns, relative to source directory, that match files and
 # directories to ignore when looking for source files.
-exclude_patterns = ['_build']
+exclude_patterns = ["_build"]
 
 # The reST default role (used for this markup: `text`) to use for all documents.
-#default_role = None
+# default_role = None
 
 # If true, '()' will be appended to :func: etc. cross-reference text.
-#add_function_parentheses = True
+# add_function_parentheses = True
 
 # If true, the current module name will be prepended to all description
 # unit titles (such as .. function::).
-#add_module_names = True
+# add_module_names = True
 
 # If true, sectionauthor and moduleauthor directives will be shown in the
 # output. They are ignored by default.
-#show_authors = False
+# show_authors = False
 
 # The name of the Pygments (syntax highlighting) style to use.
-pygments_style = 'sphinx'
+pygments_style = "sphinx"
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+html_theme = "default"
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the
 # documentation.
-#html_theme_options = {}
+# html_theme_options = {}
 
 # Add any paths that contain custom themes here, relative to this directory.
-#html_theme_path = []
+# html_theme_path = []
 
 # The name for this set of Sphinx documents.  If None, it defaults to
 # "<project> v<release> documentation".
-#html_title = None
+# html_title = None
 
 # A shorter title for the navigation bar.  Default is the same as html_title.
-#html_short_title = None
+# html_short_title = None
 
 # The name of an image file (relative to this directory) to place at the top
 # of the sidebar.
-#html_logo = None
+# html_logo = None
 
 # The name of an image file (within the static path) to use as favicon of the
 # docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
 # pixels large.
-#html_favicon = None
+# html_favicon = None
 
 # Add any paths that contain custom static files (such as style sheets) here,
 # relative to this directory. They are copied after the builtin static files,
 # so a file named "default.css" will overwrite the builtin "default.css".
-html_static_path = ['_static']
+html_static_path = ["_static"]
 
 # If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
 # using the given strftime format.
-#html_last_updated_fmt = '%b %d, %Y'
+# html_last_updated_fmt = '%b %d, %Y'
 
 # If true, SmartyPants will be used to convert quotes and dashes to
 # typographically correct entities.
-#html_use_smartypants = True
+# html_use_smartypants = True
 
 # Custom sidebar templates, maps document names to template names.
-#html_sidebars = {}
+# html_sidebars = {}
 
 # Additional templates that should be rendered to pages, maps page names to
 # template names.
-#html_additional_pages = {}
+# html_additional_pages = {}
 
 # If false, no module index is generated.
-#html_domain_indices = True
+# html_domain_indices = True
 
 # If false, no index is generated.
-#html_use_index = True
+# html_use_index = True
 
 # If true, the index is split into individual pages for each letter.
-#html_split_index = False
+# html_split_index = False
 
 # If true, links to the reST sources are added to the pages.
-#html_show_sourcelink = True
+# html_show_sourcelink = True
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = True
+# html_show_sphinx = True
 
 # If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
-#html_show_copyright = True
+# html_show_copyright = True
 
 # If true, an OpenSearch description file will be output, and all pages will
 # contain a <link> tag referring to it.  The value of this option must be the
 # base URL from which the finished HTML is served.
-#html_use_opensearch = ''
+# html_use_opensearch = ''
 
 # This is the file name suffix for HTML files (e.g. ".xhtml").
-#html_file_suffix = None
+# html_file_suffix = None
 
 # Output file base name for HTML help builder.
-htmlhelp_basename = 'sampledoc'
+htmlhelp_basename = "sampledoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
-
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
-
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # The paper size ('letterpaper' or 'a4paper').
+    #'papersize': 'letterpaper',
+    # The font size ('10pt', '11pt' or '12pt').
+    #'pointsize': '10pt',
+    # Additional stuff for the LaTeX preamble.
+    #'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'sample.tex', u'sample Documentation',
-   u'Kenneth Reitz', 'manual'),
+    ("index", "sample.tex", u"sample Documentation", u"Kenneth Reitz", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
 # the title page.
-#latex_logo = None
+# latex_logo = None
 
 # For "manual" documents, if this is true, then toplevel headings are parts,
 # not chapters.
-#latex_use_parts = False
+# latex_use_parts = False
 
 # If true, show page references after internal links.
-#latex_show_pagerefs = False
+# latex_show_pagerefs = False
 
 # If true, show URL addresses after external links.
-#latex_show_urls = False
+# latex_show_urls = False
 
 # Documents to append as an appendix to all manuals.
-#latex_appendices = []
+# latex_appendices = []
 
 # If false, no module index is generated.
-#latex_domain_indices = True
+# latex_domain_indices = True
 
 
 # -- Options for manual page output --------------------------------------------
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [
-    ('index', 'sample', u'sample Documentation',
-     [u'Kenneth Reitz'], 1)
-]
+man_pages = [("index", "sample", u"sample Documentation", [u"Kenneth Reitz"], 1)]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -227,16 +221,22 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'sample', u'sample Documentation',
-   u'Kenneth Reitz', 'sample', 'One line description of project.',
-   'Miscellaneous'),
+    (
+        "index",
+        "sample",
+        u"sample Documentation",
+        u"Kenneth Reitz",
+        "sample",
+        "One line description of project.",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.
-#texinfo_appendices = []
+# texinfo_appendices = []
 
 # If false, no module index is generated.
-#texinfo_domain_indices = True
+# texinfo_domain_indices = True
 
 # How to display URL addresses: 'footnote', 'no', or 'inline'.
-#texinfo_show_urls = 'footnote'
+# texinfo_show_urls = 'footnote'
diff --git a/sample/__init__.py b/sample/__init__.py
index f4633fa..d6e5631 100644
--- a/sample/__init__.py
+++ b/sample/__init__.py
@@ -1 +1 @@
-from .core import hmm
\ No newline at end of file
+from .core import hmm
diff --git a/sample/core.py b/sample/core.py
index 19bf06c..7b3be9f 100644
--- a/sample/core.py
+++ b/sample/core.py
@@ -1,9 +1,10 @@
 # -*- coding: utf-8 -*-
 from . import helpers
 
+
 def get_hmm():
     """Get a thought."""
-    return 'hmmm...'
+    return "hmmm..."
 
 
 def hmm():
diff --git a/setup.py b/setup.py
index 8bf1ba9..6068493 100755
--- a/setup.py
+++ b/setup.py
@@ -1,2 +1,3 @@
 from setuptools import setup
+
 setup()
diff --git a/tests/context.py b/tests/context.py
index 91de701..1305ddc 100644
--- a/tests/context.py
+++ b/tests/context.py
@@ -2,6 +2,7 @@
 
 import sys
 import os
-sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), '..')))
+
+sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
 
 import sample
diff --git a/tests/test_advanced.py b/tests/test_advanced.py
index cc48248..85cd485 100644
--- a/tests/test_advanced.py
+++ b/tests/test_advanced.py
@@ -12,5 +12,5 @@ def test_thoughts(self):
         self.assertIsNone(sample.hmm())
 
 
-if __name__ == '__main__':
+if __name__ == "__main__":
     unittest.main()
diff --git a/tests/test_basic.py b/tests/test_basic.py
index d3e4d5a..733d793 100644
--- a/tests/test_basic.py
+++ b/tests/test_basic.py
@@ -12,5 +12,5 @@ def test_absolute_truth_and_meaning(self):
         assert True
 
 
-if __name__ == '__main__':
-    unittest.main()
\ No newline at end of file
+if __name__ == "__main__":
+    unittest.main()

From 63a581489794beca0b8b9c69ee078e4d811ae2d2 Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:49:53 +0100
Subject: [PATCH 3/7] add pre-commit-config.yaml

---
 .pre-commit-config.yaml | 53 +++++++++++++++++++++++++++++++++++++++++
 1 file changed, 53 insertions(+)
 create mode 100644 .pre-commit-config.yaml

diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml
new file mode 100644
index 0000000..e9ca3b6
--- /dev/null
+++ b/.pre-commit-config.yaml
@@ -0,0 +1,53 @@
+repos:
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.7.2
+    hooks:
+      - id: pyupgrade
+        args: ["--py36-plus"]
+
+  - repo: https://github.com/psf/black
+    rev: 20.8b1
+    hooks:
+      - id: black
+        args: ["--target-version", "py36"]
+
+  - repo: https://gitlab.com/pycqa/flake8
+    rev: 3.8.3
+    hooks:
+      - id: flake8
+        additional_dependencies: [flake8-2020]
+
+  - repo: https://github.com/pycqa/isort
+    rev: 5.4.2
+    hooks:
+      - id: isort
+
+  - repo: https://github.com/pre-commit/pygrep-hooks
+    rev: v1.6.0
+    hooks:
+      - id: python-check-blanket-noqa
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: v3.2.0
+    hooks:
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: mixed-line-ending
+
+  - repo: https://github.com/prettier/prettier
+    rev: 2.1.1
+    hooks:
+      - id: prettier
+        args: [--prose-wrap=always, --print-width=88]
+
+  - repo: https://github.com/myint/autoflake
+    rev: v1.4
+    hooks:
+      - id: autoflake
+        args:
+          - --in-place
+          - --remove-all-unused-imports
+          - --expand-star-imports
+          - --remove-duplicate-keys
+          - --remove-unused-variables

From b940f0c5bb0e17bfebddbf548038b6a725b839bd Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:51:27 +0100
Subject: [PATCH 4/7] add python_requires

---
 setup.cfg | 1 +
 1 file changed, 1 insertion(+)

diff --git a/setup.cfg b/setup.cfg
index e3a0546..ec35824 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -10,6 +10,7 @@ license = file: LICENSE
 
 [options]
 packages = find:
+python_requires = ~=3.6
 
 [options.packages.find]
 exclude =

From 6cc392a5a9d4d22cbfb88340be50586b82d058fb Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:51:43 +0100
Subject: [PATCH 5/7] configure universal wheels

---
 setup.cfg | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/setup.cfg b/setup.cfg
index ec35824..d9c30ff 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -16,3 +16,6 @@ python_requires = ~=3.6
 exclude =
     tests
     docs
+
+[bdist_wheel]
+universal = 1

From c90e432209262e5a90badadce49b01237798349f Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:53:09 +0100
Subject: [PATCH 6/7] configure flake8

---
 setup.cfg | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/setup.cfg b/setup.cfg
index d9c30ff..81a5d73 100644
--- a/setup.cfg
+++ b/setup.cfg
@@ -19,3 +19,9 @@ exclude =
 
 [bdist_wheel]
 universal = 1
+
+[flake8]
+disable-noqa = True
+max-line-length = 88
+extend-ignore =
+   E203,  # whitespace before : is not PEP8 compliant (& conflicts with black)

From 545989e26e8fa81fe9d571d270c2e3f3093e3bec Mon Sep 17 00:00:00 2001
From: Thomas Grainger <tagrain@gmail.com>
Date: Wed, 30 Sep 2020 22:53:21 +0100
Subject: [PATCH 7/7] configure pre-commit

---
 docs/conf.py           | 20 +++++++++-----------
 sample/__init__.py     |  1 -
 sample/core.py         |  1 -
 tests/context.py       |  6 +-----
 tests/test_advanced.py |  4 +---
 tests/test_basic.py    |  4 ----
 6 files changed, 11 insertions(+), 25 deletions(-)

diff --git a/docs/conf.py b/docs/conf.py
index 2ae8559..8604236 100644
--- a/docs/conf.py
+++ b/docs/conf.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # sample documentation build configuration file, created by
 # sphinx-quickstart on Mon Apr 16 21:22:43 2012.
@@ -11,7 +10,6 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the
@@ -40,8 +38,8 @@
 master_doc = "index"
 
 # General information about the project.
-project = u"sample"
-copyright = u"2012, Kenneth Reitz"
+project = "sample"
+copyright = "2012, Kenneth Reitz"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -171,17 +169,17 @@
 
 latex_elements = {
     # The paper size ('letterpaper' or 'a4paper').
-    #'papersize': 'letterpaper',
+    # 'papersize': 'letterpaper',
     # The font size ('10pt', '11pt' or '12pt').
-    #'pointsize': '10pt',
+    # 'pointsize': '10pt',
     # Additional stuff for the LaTeX preamble.
-    #'preamble': '',
+    # 'preamble': '',
 }
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-    ("index", "sample.tex", u"sample Documentation", u"Kenneth Reitz", "manual"),
+    ("index", "sample.tex", "sample Documentation", "Kenneth Reitz", "manual"),
 ]
 
 # The name of an image file (relative to this directory) to place at the top of
@@ -209,7 +207,7 @@
 
 # One entry per manual page. List of tuples
 # (source start file, name, description, authors, manual section).
-man_pages = [("index", "sample", u"sample Documentation", [u"Kenneth Reitz"], 1)]
+man_pages = [("index", "sample", "sample Documentation", ["Kenneth Reitz"], 1)]
 
 # If true, show URL addresses after external links.
 # man_show_urls = False
@@ -224,8 +222,8 @@
     (
         "index",
         "sample",
-        u"sample Documentation",
-        u"Kenneth Reitz",
+        "sample Documentation",
+        "Kenneth Reitz",
         "sample",
         "One line description of project.",
         "Miscellaneous",
diff --git a/sample/__init__.py b/sample/__init__.py
index d6e5631..e69de29 100644
--- a/sample/__init__.py
+++ b/sample/__init__.py
@@ -1 +0,0 @@
-from .core import hmm
diff --git a/sample/core.py b/sample/core.py
index 7b3be9f..c357ae5 100644
--- a/sample/core.py
+++ b/sample/core.py
@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 from . import helpers
 
 
diff --git a/tests/context.py b/tests/context.py
index 1305ddc..1406b77 100644
--- a/tests/context.py
+++ b/tests/context.py
@@ -1,8 +1,4 @@
-# -*- coding: utf-8 -*-
-
-import sys
 import os
+import sys
 
 sys.path.insert(0, os.path.abspath(os.path.join(os.path.dirname(__file__), "..")))
-
-import sample
diff --git a/tests/test_advanced.py b/tests/test_advanced.py
index 85cd485..574e478 100644
--- a/tests/test_advanced.py
+++ b/tests/test_advanced.py
@@ -1,9 +1,7 @@
-# -*- coding: utf-8 -*-
+import unittest
 
 from .context import sample
 
-import unittest
-
 
 class AdvancedTestSuite(unittest.TestCase):
     """Advanced test cases."""
diff --git a/tests/test_basic.py b/tests/test_basic.py
index 733d793..f26453b 100644
--- a/tests/test_basic.py
+++ b/tests/test_basic.py
@@ -1,7 +1,3 @@
-# -*- coding: utf-8 -*-
-
-from .context import sample
-
 import unittest