Clean up leftovers and inconsistencies found in a project audit

.flake8

@@ -0,0 +1,4 @@
+[flake8]
+# The GitHub editor is 127 chars wide
+max-line-length = 127
+exclude = .git,__pycache__,build,dist,doc/_build

.github/workflows/test.yaml

@@ -23,11 +23,8 @@ jobs:
           python -m pip install --upgrade pip
           pip install flake8
       - name: Lint with flake8
-        run: |
-          # stop the build if there are Python syntax errors or undefined names
-          flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
-          # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide
-          flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics
+        # configured in .flake8
+        run: flake8 . --count --show-source --statistics
 
   build:
     name: "Build and check distributions"

MANIFEST.in

@@ -1,8 +1,13 @@
 include requirements.txt
+include requirements-dev.txt
 include LICENSE
 include README.md
 include tests.py
 include doc/*.rst
+include doc/conf.py
+include doc/Makefile
+include doc/requirements.txt
+include makefile
 include property_tests.py
 include pytest.ini
 include ext_tests.py

README.md

@@ -1,8 +1,8 @@
 python-json-patch
 =================
 
-[![PyPI version](https://img.shields.io/pypi/v/jsonpatch.svg)](https://pypi.org/project/jsonpatch//)
-[![Supported Python versions](https://img.shields.io/pypi/pyversions/jsonpatch.svg)](https://pypi.org/project/jsonpatch//)
+[![PyPI version](https://img.shields.io/pypi/v/jsonpatch.svg)](https://pypi.org/project/jsonpatch/)
+[![Supported Python versions](https://img.shields.io/pypi/pyversions/jsonpatch.svg)](https://pypi.org/project/jsonpatch/)
 [![Build Status](https://github.com/stefankoegl/python-json-patch/actions/workflows/test.yaml/badge.svg?branch=master)](https://github.com/stefankoegl/python-json-patch/actions/workflows/test.yaml)
 [![Coverage Status](https://coveralls.io/repos/github/stefankoegl/python-json-patch/badge.svg?branch=master)](https://coveralls.io/github/stefankoegl/python-json-patch?branch=master)
 
@@ -12,11 +12,12 @@ Applying JSON Patches in Python
 Library to apply JSON Patches according to
 [RFC 6902](https://datatracker.ietf.org/doc/html/rfc6902)
 
-See source code for examples
+See the [tutorial](https://python-json-patch.readthedocs.io/en/latest/tutorial.html)
+for examples.
 
 * Website: https://github.com/stefankoegl/python-json-patch
 * Repository: https://github.com/stefankoegl/python-json-patch.git
-* Documentation: https://python-json-patch.readthedocs.org/
+* Documentation: https://python-json-patch.readthedocs.io/
 * PyPI: https://pypi.org/project/jsonpatch/
 * CI: https://github.com/stefankoegl/python-json-patch/actions
 * Coveralls: https://coveralls.io/github/stefankoegl/python-json-patch
@@ -28,7 +29,8 @@ non-RFC string `append` operation. Its `from_diff()` method sends only the
 new suffix when an object member's string grows. `JsonPatch`, `make_patch()`
 and `apply_patch()` retain their standard RFC 6902 behavior.
 
-See the [tutorial](doc/tutorial.rst#string-append-extension) for examples.
+See the [tutorial](https://python-json-patch.readthedocs.io/en/latest/tutorial.html#string-append-extension)
+for examples.
 Both sender and receiver must support the extension.
 
 Type hints
@@ -45,6 +47,11 @@ typical usage in `typetests/usage.py` type-checks:
     python -m mypy.stubtest --mypy-config-file pyproject.toml jsonpatch
     cd typetests && mypy --config-file ../pyproject.toml usage.py
 
+Running tests
+-------------
+    pip install -r requirements.txt -r requirements-dev.txt
+    python tests.py
+
 Running external tests
 ----------------------
 To run external tests (such as those from https://github.com/json-patch/json-patch-tests) use ext_tests.py
@@ -54,8 +61,7 @@ To run external tests (such as those from https://github.com/json-patch/json-pat
 Running property-based tests
 ----------------------------
 Property-based tests using [Hypothesis](https://hypothesis.readthedocs.io/)
-are in property_tests.py. Properties that the implementation does not satisfy
-yet are marked as expected failures.
+are in property_tests.py.
 
     pip install hypothesis
     python property_tests.py

doc/conf.py

@@ -11,19 +11,20 @@
 # All configuration values have a default; values that are commented out
 # serve to show the default.
 
-import sys, os
+import sys
+import 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
 # documentation root, use os.path.abspath to make it absolute, like shown here.
 sys.path.insert(0, os.path.join(os.path.abspath('.'), '..'))
 
-import jsonpatch
+import jsonpatch  # noqa: E402, needs the path set above
 
 # -- 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.
@@ -34,20 +35,20 @@
 nitpick_ignore = [('py:class', 'JsonPointer')]
 
 # Add any paths that contain templates here, relative to this directory.
-templates_path = ['_templates']
+templates_path = []
 
 # The suffix of source filenames.
 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'
 
 # General information about the project.
-project = u'python-json-patch'
-copyright = jsonpatch.__author__
+project = 'python-json-patch'
+copyright = '2011, Stefan Kögl'
 
 # The version info for the project you're documenting, acts as replacement for
 # |version| and |release|, also used in various other places throughout the
@@ -61,37 +62,37 @@
 
 # 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']
 
 # 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'
 
 # A list of ignored prefixes for module index sorting.
-#modindex_common_prefix = []
+# modindex_common_prefix = []
 
 
 # -- Options for HTML output ---------------------------------------------------
@@ -103,72 +104,72 @@
 # 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 = []
 
 # 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 = 'python-json-patchdoc'
@@ -177,55 +178,55 @@
 # -- Options for LaTeX output --------------------------------------------------
 
 latex_elements = {
-# The paper size ('letterpaper' or 'a4paper').
-#'papersize': 'letterpaper',
+    # The paper size ('letterpaper' or 'a4paper').
+    # 'papersize': 'letterpaper',
 
-# The font size ('10pt', '11pt' or '12pt').
-#'pointsize': '10pt',
+    # The font size ('10pt', '11pt' or '12pt').
+    # 'pointsize': '10pt',
 
-# Additional stuff for the LaTeX preamble.
-#'preamble': '',
+    # 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', 'python-json-patch.tex', u'python-json-patch Documentation',
-   u'Stefan Kögl', 'manual'),
+  ('index', 'python-json-patch.tex', 'python-json-patch Documentation',
+   'Stefan Kögl', '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', 'python-json-patch', u'python-json-patch Documentation',
-     [u'Stefan Kögl'], 1)
+    ('index', 'python-json-patch', 'python-json-patch Documentation',
+     ['Stefan Kögl'], 1)
 ]
 
 # If true, show URL addresses after external links.
-#man_show_urls = False
+# man_show_urls = False
 
 
 # -- Options for Texinfo output ------------------------------------------------
@@ -234,16 +235,16 @@
 # (source start file, target name, title, author,
 #  dir menu entry, description, category)
 texinfo_documents = [
-  ('index', 'python-json-patch', u'python-json-patch Documentation',
-   u'Stefan Kögl', 'python-json-patch', 'One line description of project.',
+  ('index', 'python-json-patch', 'python-json-patch Documentation',
+   'Stefan Kögl', 'python-json-patch', 'Apply JSON Patches (RFC 6902)',
    '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'

doc/mod-jsonpatch.rst

@@ -1,4 +1,4 @@
-.. mod-jsonpatch:
+.. _mod-jsonpatch:
 
 The ``jsonpatch`` module
 ========================