diff --git a/docs/conf.py b/docs/conf.py index 23e156a..2c919c4 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -15,44 +15,44 @@ import sys import os -sys.path.append(os.path.abspath('..')) +sys.path.append(os.path.abspath("..")) from tap import __version__ # 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 = [ - 'sphinx.ext.autodoc', + "sphinx.ext.autodoc", ] # autodoc settings -autodoc_member_order = 'bysource' +autodoc_member_order = "bysource" # 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'tappy' -copyright = u'2019, Matt Layman and contributors' +project = u"tappy" +copyright = u"Matt Layman and contributors" # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -65,181 +65,181 @@ # 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 = [] # If true, keep warnings as "system message" paragraphs in the built documents. -#keep_warnings = False +# keep_warnings = False # -- 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 # " v 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"] # Add any extra paths that contain custom files (such as robots.txt or # .htaccess) here, relative to this directory. These files are copied # directly to the root of the documentation. -#html_extra_path = [] +# html_extra_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 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 = 'tappydoc' +htmlhelp_basename = "tappydoc" # -- 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, or own class]). latex_documents = [ - ('index', 'tappy.tex', u'tappy Documentation', - u'Matt Layman and contributors', 'manual'), + ( + "index", + "tappy.tex", + u"tappy Documentation", + u"Matt Layman and contributors", + "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 = [ - ('tappy.1', 'tappy', u'a tap consumer for python', - [], 1) -] +man_pages = [("tappy.1", "tappy", u"a tap consumer for python", [], 1)] # If true, show URL addresses after external links. -#man_show_urls = False +# man_show_urls = False # -- Options for Texinfo output ------------------------------------------- @@ -248,19 +248,25 @@ # (source start file, target name, title, author, # dir menu entry, description, category) texinfo_documents = [ - ('index', 'tappy', u'tappy Documentation', - u'Matt Layman and contributors', 'tappy', 'One line description of project.', - 'Miscellaneous'), + ( + "index", + "tappy", + u"tappy Documentation", + u"Matt Layman and contributors", + "tappy", + "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' # If true, do not generate a @detailmenu in the "Top" node's menu. -#texinfo_no_detailmenu = False +# texinfo_no_detailmenu = False diff --git a/setup.cfg b/setup.cfg index 21dc8f9..36fa184 100644 --- a/setup.cfg +++ b/setup.cfg @@ -1,15 +1,6 @@ [bdist_wheel] universal = 1 -[compile_catalog] -domain = tappy -directory = tap/locale - -[extract_messages] -input_dirs = tap -output_file = tap/locale/tappy.pot -copyright_holder = Matt Layman - [flake8] max-line-length = 88 diff --git a/setup.py b/setup.py index a6e1357..6377a4c 100644 --- a/setup.py +++ b/setup.py @@ -1,4 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors """ tappy is a set of tools for working with the `Test Anything Protocol (TAP) `_, a line based test protocol for recording test diff --git a/tap/__init__.py b/tap/__init__.py index 613a61a..b79ce04 100644 --- a/tap/__init__.py +++ b/tap/__init__.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - from .runner import TAPTestRunner __all__ = ["TAPTestRunner"] diff --git a/tap/adapter.py b/tap/adapter.py index 7f76279..e1de49e 100644 --- a/tap/adapter.py +++ b/tap/adapter.py @@ -1,6 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - - class Adapter(object): """The adapter processes a TAP test line and updates a unittest result. diff --git a/tap/directive.py b/tap/directive.py index c114309..216208a 100644 --- a/tap/directive.py +++ b/tap/directive.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import re diff --git a/tap/line.py b/tap/line.py index fc8f8e2..e5b03bf 100644 --- a/tap/line.py +++ b/tap/line.py @@ -1,4 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors try: import yaml diff --git a/tap/loader.py b/tap/loader.py index b07b567..2b401fc 100644 --- a/tap/loader.py +++ b/tap/loader.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import os import unittest diff --git a/tap/main.py b/tap/main.py index e6761a9..b82e660 100644 --- a/tap/main.py +++ b/tap/main.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import argparse import sys import unittest diff --git a/tap/parser.py b/tap/parser.py index 6241464..c622b5e 100644 --- a/tap/parser.py +++ b/tap/parser.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - from io import StringIO import itertools import re diff --git a/tap/rules.py b/tap/rules.py index 5c1ee4f..3a519e9 100644 --- a/tap/rules.py +++ b/tap/rules.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - from tap.adapter import Adapter from tap.directive import Directive from tap.line import Result diff --git a/tap/runner.py b/tap/runner.py index 8fe7a00..3175e3e 100644 --- a/tap/runner.py +++ b/tap/runner.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import os from unittest import TextTestResult, TextTestRunner from unittest.runner import _WritelnDecorator diff --git a/tap/tests/__init__.py b/tap/tests/__init__.py index 44fdf65..97cfec3 100644 --- a/tap/tests/__init__.py +++ b/tap/tests/__init__.py @@ -1,4 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors """Tests for tappy""" from tap.tests.testcase import TestCase # NOQA diff --git a/tap/tests/factory.py b/tap/tests/factory.py index 3c6308d..f17526c 100644 --- a/tap/tests/factory.py +++ b/tap/tests/factory.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import sys import tempfile from unittest.runner import TextTestResult diff --git a/tap/tests/run.py b/tap/tests/run.py index 1e47fca..8d1eb80 100644 --- a/tap/tests/run.py +++ b/tap/tests/run.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import os import sys import unittest diff --git a/tap/tests/test_adapter.py b/tap/tests/test_adapter.py index 1d89b87..0aaa87c 100644 --- a/tap/tests/test_adapter.py +++ b/tap/tests/test_adapter.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - from unittest import mock from tap.adapter import Adapter diff --git a/tap/tests/test_directive.py b/tap/tests/test_directive.py index 890e81a..ea30166 100644 --- a/tap/tests/test_directive.py +++ b/tap/tests/test_directive.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import unittest from tap.directive import Directive diff --git a/tap/tests/test_line.py b/tap/tests/test_line.py index 3410e41..ae2c819 100644 --- a/tap/tests/test_line.py +++ b/tap/tests/test_line.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import unittest from tap.directive import Directive diff --git a/tap/tests/test_loader.py b/tap/tests/test_loader.py index d02f5a5..ba89b8f 100644 --- a/tap/tests/test_loader.py +++ b/tap/tests/test_loader.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import inspect from io import StringIO import os diff --git a/tap/tests/test_main.py b/tap/tests/test_main.py index be85200..8e66ea4 100644 --- a/tap/tests/test_main.py +++ b/tap/tests/test_main.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import argparse import os from unittest import mock diff --git a/tap/tests/test_parser.py b/tap/tests/test_parser.py index 94850bc..d94e45b 100644 --- a/tap/tests/test_parser.py +++ b/tap/tests/test_parser.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - from contextlib import contextmanager import inspect from io import BytesIO, StringIO diff --git a/tap/tests/test_result.py b/tap/tests/test_result.py index 6974556..378c70d 100644 --- a/tap/tests/test_result.py +++ b/tap/tests/test_result.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import contextlib import os import unittest diff --git a/tap/tests/test_rules.py b/tap/tests/test_rules.py index 0405890..8ff0f5c 100644 --- a/tap/tests/test_rules.py +++ b/tap/tests/test_rules.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import unittest from tap.rules import Rules diff --git a/tap/tests/test_runner.py b/tap/tests/test_runner.py index 507764e..6834637 100644 --- a/tap/tests/test_runner.py +++ b/tap/tests/test_runner.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import os import sys import tempfile diff --git a/tap/tests/test_tracker.py b/tap/tests/test_tracker.py index 89a4cfb..807d2db 100644 --- a/tap/tests/test_tracker.py +++ b/tap/tests/test_tracker.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import inspect from io import StringIO import os diff --git a/tap/tests/testcase.py b/tap/tests/testcase.py index 3a41ece..3a72e88 100644 --- a/tap/tests/testcase.py +++ b/tap/tests/testcase.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import unittest from tap.tests.factory import Factory diff --git a/tap/tracker.py b/tap/tracker.py index 6ba23f7..bc54bd0 100644 --- a/tap/tracker.py +++ b/tap/tracker.py @@ -1,5 +1,3 @@ -# Copyright (c) 2019, Matt Layman and contributors - import os from tap.directive import Directive