Add support for blocking users

This also adds to our pre-commit configuration, upgrades how we build
the package, and updates things with black.

This supports blocking users from organizations and individual accounts.

Author: sigmavirus24

.gitignore

@@ -25,3 +25,4 @@ tests/id_rsa
 t.py
 *.pem
 /.python-version
+/.tool-versions

.pre-commit-config.yaml

@@ -13,3 +13,31 @@ repos:
     - id: trailing-whitespace
       types: [text]
       stages: [commit, push, manual]
+  - repo: https://github.com/asottile/reorder_python_imports
+    rev: v2.6.0
+    hooks:
+    - id: reorder-python-imports
+      args: [--application-directories, '.:src', --py36-plus]
+  - repo: https://github.com/psf/black
+    rev: 21.9b0
+    hooks:
+    - id: black
+  - repo: https://github.com/asottile/pyupgrade
+    rev: v2.23.3
+    hooks:
+    - id: pyupgrade
+      args: [--py36-plus]
+  #- repo: https://github.com/pre-commit/mirrors-mypy
+  #  rev: v0.910
+  #  hooks:
+  #  - id: mypy
+  #    exclude: ^(docs/|tests/)
+  - repo: https://github.com/jorisroovers/gitlint
+    rev: v0.16.0
+    hooks:
+    - id: gitlint
+  - repo: https://github.com/asottile/setup-cfg-fmt
+    rev: v1.18.0
+    hooks:
+    - id: setup-cfg-fmt
+      args: [--min-py3-version, '3.6']

docs/source/conf.py

@@ -1,4 +1,3 @@
-# -*- coding: utf-8 -*-
 #
 # Requests documentation build configuration file, created by
 # sphinx-quickstart on Sun Feb 13 23:54:25 2011.
@@ -10,43 +9,43 @@
 #
 # All configuration values have a default; values that are commented out
 # serve to show the default.
-
-import sys, os
+import os
+import sys
 
 # This environment variable makes decorators not decorate functions, so their
 # signatures in the generated documentation are still correct
-os.environ['GENERATING_DOCUMENTATION'] = "github3"
+os.environ["GENERATING_DOCUMENTATION"] = "github3"
 
 # 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(".."))
 import github3
 
 # -- 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 = ['sphinx.ext.autodoc']
+extensions = ["sphinx.ext.autodoc"]
 
 # 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 = 'github3.py'
-copyright = '2012-2021 - Ian Stapleton Cordasco'
+project = "github3.py"
+copyright = "2012-2021 - Ian Stapleton Cordasco"
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -59,181 +58,192 @@
 
 # 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 = 'flask_theme_support.FlaskyStyle'
 
 # 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 = 'nature'
+# html_theme = 'nature'
 html_theme = "sphinx_rtd_theme"
 
 # 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 = '../img/gh3-logo-transparent.png'
+html_logo = "../img/gh3-logo-transparent.png"
 
 
 # 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.
 # 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 = False
+# html_show_sourcelink = False
 
 # If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
-#html_show_sphinx = False
+# html_show_sphinx = False
 
 # 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 = 'github3.pydoc'
+htmlhelp_basename = "github3.pydoc"
 
 
 # -- Options for LaTeX output --------------------------------------------------
 
 # The paper size ('letter' or 'a4').
-#latex_paper_size = 'letter'
+# latex_paper_size = 'letter'
 
 # The font size ('10pt', '11pt' or '12pt').
-#latex_font_size = '10pt'
+# latex_font_size = '10pt'
 
 # Grouping the document tree into LaTeX files. List of tuples
 # (source start file, target name, title, author, documentclass [howto/manual]).
 latex_documents = [
-  ('index', 'github3.py.tex', 'github3.py Documentation',
-   'Ian Cordasco', 'manual'),
+    (
+        "index",
+        "github3.py.tex",
+        "github3.py Documentation",
+        "Ian Cordasco",
+        "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
 
 # Additional stuff for the LaTeX preamble.
-#latex_preamble = ''
+# latex_preamble = ''
 
 # 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', 'github3.py', 'github3.py Documentation',
-     ['Ian Cordasco'], 1)
+    ("index", "github3.py", "github3.py Documentation", ["Ian Cordasco"], 1)
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 # -- Options for Texinfo output ------------------------------------------------
 
 # Grouping the document tree into Texinfo files. List of tuples
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'github3.py', 'github3.py Documentation', 'Ian Cordasco',
-   'github3.py', 'Wrapper for GitHub API v3', 'Miscellaneous'),
+    (
+        "index",
+        "github3.py",
+        "github3.py Documentation",
+        "Ian Cordasco",
+        "github3.py",
+        "Wrapper for GitHub API v3",
+        "Miscellaneous",
+    ),
 ]
 
 # Documents to append as an appendix to all manuals.

docs/source/examples/source/browser.py

@@ -1,11 +1,12 @@
-import webbrowser
 import tempfile
+import webbrowser
+
 import github3
 
 template = """<html><head></head><body>{0}</body></html>"""
 
-i = github3.issue('kennethreitz', 'requests', 868)
+i = github3.issue("kennethreitz", "requests", 868)
 
 with tempfile.NamedTemporaryFile() as tmpfd:
     tmpfd.write(template.format(i.body_html))
-    webbrowser.open('file://' + tmpfd.name)
+    webbrowser.open("file://" + tmpfd.name)

docs/source/examples/source/logging_ex.py

@@ -1,29 +1,30 @@
-import github3
 import logging
 
+import github3
+
 # Set up a file to have all the logs written to
-file_handler = logging.FileHandler('github_script.log')
+file_handler = logging.FileHandler("github_script.log")
 
 # Send the logs to stderr as well
 stream_handler = logging.StreamHandler()
 
 # Format the log output and include the log level's name and the time it was
 # generated
-formatter = logging.Formatter('%(asctime)s %(levelname)s %(message)s')
+formatter = logging.Formatter("%(asctime)s %(levelname)s %(message)s")
 
 # Use that Formatter on both handlers
 file_handler.setFormatter(formatter)
 stream_handler.setFormatter(formatter)
 
 # Get the logger used by github3.py internally by referencing its name
 # directly
-logger = logging.getLogger('github3')
+logger = logging.getLogger("github3")
 # Add the handlers to it
 logger.addHandler(file_handler)
 logger.addHandler(stream_handler)
 # Set the level which determines what you see
 logger.setLevel(logging.DEBUG)
 
 # Make a library call and see the information posted
-r = github3.repository('sigmavirus24', 'github3.py')
-print('{0} - {0.html_url}'.format(r))
+r = github3.repository("sigmavirus24", "github3.py")
+print("{0} - {0.html_url}".format(r))