././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1640756615.7042024
tap.py-3.1/ 0000755 0000765 0000024 00000000000 00000000000 011421 5 ustar 00matt staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1612453674.0
tap.py-3.1/AUTHORS 0000644 0000765 0000024 00000000512 00000000000 012467 0 ustar 00matt staff tappy was originally created by Matt Layman.
Contributors
------------
* Adeodato Simó
* Andrew McNamara
* Chris Clarke
* Erik Cederstrand
* Marc Abramowitz
* Mark E. Hamilton
* Matt Layman
* meejah (https://meejah.ca)
* Michael F. Lamb (http://datagrok.org)
* Nicolas Caniart
* Richard Bosworth
* Ross Burton
* Simon McVittie
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1568681898.0
tap.py-3.1/LICENSE 0000644 0000765 0000024 00000002476 00000000000 012437 0 ustar 00matt staff Copyright (c) 2019, Matt Layman and contributors. See AUTHORS for more details.
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1640755752.0
tap.py-3.1/MANIFEST.in 0000644 0000765 0000024 00000000135 00000000000 013156 0 ustar 00matt staff include AUTHORS
include LICENSE
include README.md
recursive-include docs *
prune docs/_build
././@PaxHeader 0000000 0000000 0000000 00000000033 00000000000 010211 x ustar 00 27 mtime=1640756615.704442
tap.py-3.1/PKG-INFO 0000644 0000765 0000024 00000016316 00000000000 012525 0 ustar 00matt staff Metadata-Version: 2.1
Name: tap.py
Version: 3.1
Summary: Test Anything Protocol (TAP) tools
Home-page: https://github.com/python-tap/tappy
Author: Matt Layman
Author-email: matthewlayman@gmail.com
License: BSD
Keywords: TAP,unittest
Platform: any
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: Topic :: Software Development :: Testing
Provides-Extra: yaml
License-File: LICENSE
tappy is a set of tools for working with the `Test Anything Protocol (TAP)
`_, a line based test protocol for recording test
data in a standard way.
Follow tappy development on `GitHub `_.
Developer documentation is on
`Read the Docs `_.
Releases
========
Version 3.1, Released December 29, 2021
---------------------------------------
* Add support for Python 3.10.
* Add support for Python 3.9.
* Add support for Python 3.8.
* Drop support for Python 3.5 (it is end-of-life).
* Fix parsing of multi-line strings in YAML blocks (#111)
* Remove unmaintained i18n support.
Version 3.0, Released January 10, 2020
--------------------------------------
* Drop support for Python 2 (it is end-of-life).
* Add support for subtests.
* Run a test suite with ``python -m tap``.
* Discontinue use of Pipenv for managing development.
Version 2.6.2, Released October 20, 2019
----------------------------------------
* Fix bug in streaming mode that would generate tap files
when the plan was already set (affected pytest).
Version 2.6.1, Released September 17, 2019
------------------------------------------
* Fix TAP version 13 support from more-itertools behavior change.
Version 2.6, Released September 16, 2019
----------------------------------------
* Add support for Python 3.7.
* Drop support for Python 3.4 (it is end-of-life).
Version 2.5, Released September 15, 2018
----------------------------------------
* Add ``set_plan`` to ``Tracker`` which allows producing the ``1..N`` plan line
before any tests.
* Switch code style to use Black formatting.
Version 2.4, Released May 29, 2018
----------------------------------
* Add support for producing TAP version 13 output
to streaming and file reports
by including the ``TAP version 13`` line.
Version 2.3, Released May 15, 2018
----------------------------------
* Add optional method to install tappy for YAML support
with ``pip install tap.py[yaml]``.
* Make tappy version 13 compliant by adding support for parsing YAML blocks.
* ``unittest.expectedFailure`` now uses a TODO directive to better align
with the specification.
Version 2.2, Released January 7, 2018
-------------------------------------
* Add support for Python 3.6.
* Drop support for Python 3.3 (it is end-of-life).
* Use Pipenv for managing development.
* Switch to pytest as the development test runner.
Version 2.1, Released September 23, 2016
----------------------------------------
* Add ``Parser.parse_text`` to parse TAP
provided as a string.
Version 2.0, Released July 31, 2016
-----------------------------------
* Remove nose plugin.
The plugin moved to the ``nose-tap`` distribution.
* Remove pytest plugin.
The plugin moved to the ``pytest-tap`` distribution.
* Remove Pygments syntax highlighting plugin.
The plugin was merged upstream directly into the Pygments project
and is available without tappy.
* Drop support for Python 2.6.
Version 1.9, Released March 28, 2016
------------------------------------
* ``TAPTestRunner`` has a ``set_header`` method
to enable or disable test case header ouput in the TAP stream.
* Add support for Python 3.5.
* Perform continuous integration testing on OS X.
* Drop support for Python 3.2.
Version 1.8, Released November 30, 2015
---------------------------------------
* The ``tappy`` TAP consumer can read a TAP stream
directly from STDIN.
* Tracebacks are included as diagnostic output
for failures and errors.
* The ``tappy`` TAP consumer has an alternative, shorter name
of ``tap``.
* The pytest plugin now defaults to no output
unless provided a flag.
Users dependent on the old default behavior
can use ``--tap-files`` to achieve the same results.
* Translated into Arabic.
* Translated into Chinese.
* Translated into Japanese.
* Translated into Russian.
* Perform continuous integration testing on Windows with AppVeyor.
* Improve unit test coverage to 100%.
Version 1.7, Released August 19, 2015
-------------------------------------
* Provide a plugin to integrate with pytest.
* Document some viable alternatives to tappy.
* Translated into German.
* Translated into Portuguese.
Version 1.6, Released June 18, 2015
-----------------------------------
* ``TAPTestRunner`` has a ``set_stream`` method to stream all TAP
output directly to an output stream instead of a file.
results in a single output file.
* The ``nosetests`` plugin has an optional ``--tap-stream`` flag to
stream all TAP output directly to an output stream instead of a file.
* tappy is now internationalized. It is translated into Dutch, French,
Italian, and Spanish.
* tappy is available as a Python wheel package, the new Python packaging
standard.
Version 1.5, Released May 18, 2015
----------------------------------
* ``TAPTestRunner`` has a ``set_combined`` method to collect all
results in a single output file.
* The ``nosetests`` plugin has an optional ``--tap-combined`` flag to
collect all results in a single output file.
* ``TAPTestRunner`` has a ``set_format`` method to specify line format.
* The ``nosetests`` plugin has an optional ``--tap-format`` flag to specify
line format.
Version 1.4, Released April 4, 2015
-----------------------------------
* Update ``setup.py`` to support Debian packaging. Include man page.
Version 1.3, Released January 9, 2015
-------------------------------------
* The ``tappy`` command line tool is available as a TAP consumer.
* The ``Parser`` and ``Loader`` are available as APIs for programmatic
handling of TAP files and data.
Version 1.2, Released December 21, 2014
---------------------------------------
* Provide a syntax highlighter for Pygments so any project using Pygments
(e.g., Sphinx) can highlight TAP output.
Version 1.1, Released October 23, 2014
--------------------------------------
* ``TAPTestRunner`` has a ``set_outdir`` method to specify where to store
``.tap`` files.
* The ``nosetests`` plugin has an optional ``--tap-outdir`` flag to specify
where to store ``.tap`` files.
* tappy has backported support for Python 2.6.
* tappy has support for Python 3.2, 3.3, and 3.4.
* tappy has support for PyPy.
Version 1.0, Released March 16, 2014
------------------------------------
* Initial release of tappy
* ``TAPTestRunner`` - A test runner for ``unittest`` modules that generates
TAP files.
* Provides a plugin for integrating with **nose**.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1640753247.0
tap.py-3.1/README.md 0000644 0000765 0000024 00000007042 00000000000 012703 0 ustar 00matt staff tappy
=====
[![PyPI version][pypishield]](https://pypi.python.org/pypi/tap.py)
[![Coverage][coverage]](https://codecov.io/github/python-tap/tappy)
tappy is a set of tools for working with the
[Test Anything Protocol (TAP)][tap] in Python. TAP is a line based test
protocol for recording test data in a standard way.
Full documentation for tappy is at [Read the Docs][rtd]. The information
below provides a synopsis of what tappy supplies.
For the curious: tappy sounds like "happy."
If you find tappy useful, please consider starring the repository to show a
kindness and help others discover something valuable. Thanks!
Installation
------------
tappy is available for download from [PyPI][pypi]. tappy is currently supported
on Python
3.6,
3.7,
3.8,
3.9,
3.10,
and PyPy.
It is continuously tested on Linux, OS X, and Windows.
```bash
$ pip install tap.py
```
For testing with [pytest][pytest],
you only need to install `pytest-tap`.
```bash
$ pip install pytest-tap
```
For testing with [nose][ns],
you only need to install `nose-tap`.
```bash
$ pip install nose-tap
```
TAP version 13 brings support
for [YAML blocks](http://testanything.org/tap-version-13-specification.html#yaml-blocks)
associated with test results.
To work with version 13, install the optional dependencies.
Learn more about YAML support
in the [TAP version 13](http://tappy.readthedocs.io/en/latest/consumers.html#tap-version-13) section.
```bash
$ pip install tap.py[yaml]
```
Motivation
----------
Some projects have mixed programming environments with many
programming languages and tools. Because of TAP's simplicity,
it can function as a *lingua franca* for testing.
When every testing tool can create TAP,
a team can get a holistic view of their system.
Python did not have a bridge from `unittest` to TAP so it was
difficult to integrate a Python test suite into a larger TAP ecosystem.
tappy is Python's bridge to TAP.
![TAP streaming demo][stream]
Goals
-----
1. Provide [TAP Producers][produce] which translate Python's `unittest` into
TAP.
2. Provide a [TAP Consumer][consume] which reads TAP and provides a
programmatic API in Python or generates summary results.
3. Provide a command line interface for reading TAP.
Producers
---------
* `TAPTestRunner` - This subclass of `unittest.TextTestRunner` provides all
the functionality of `TextTestRunner` and generates TAP files.
* tappy for [nose][ns] -
`nose-tap` provides a plugin
for the **nose** testing tool.
* tappy for [pytest][pytest] -
`pytest-tap` provides a plugin
for the **pytest** testing tool.
Consumers
---------
* `tappy` - A command line tool for processing TAP files.
* `Loader` and `Parser` - Python APIs for handling of TAP files and data.
Contributing
------------
The project welcomes contributions of all kinds.
Check out the [contributing guidelines][contributing]
for tips on how to get started.
[tap]: http://testanything.org/
[pypishield]: https://img.shields.io/pypi/v/tap.py.svg
[coverage]: https://img.shields.io/codecov/c/github/python-tap/tappy.svg
[rtd]: http://tappy.readthedocs.io/en/latest/
[pypi]: https://pypi.python.org/pypi/tap.py
[stream]: https://github.com/python-tap/tappy/blob/main/docs/images/stream.gif
[produce]: http://testanything.org/producers.html
[consume]: http://testanything.org/consumers.html
[ns]: https://nose.readthedocs.io/en/latest/
[pytest]: http://pytest.org/latest/
[contributing]: http://tappy.readthedocs.io/en/latest/contributing.html
././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1640756615.6908352
tap.py-3.1/docs/ 0000755 0000765 0000024 00000000000 00000000000 012351 5 ustar 00matt staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1429298097.0
tap.py-3.1/docs/Makefile 0000644 0000765 0000024 00000015146 00000000000 014020 0 ustar 00matt staff # Makefile for Sphinx documentation
#
# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build
# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif
# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext
help:
@echo "Please use \`make ' where is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"
clean:
rm -rf $(BUILDDIR)/*
html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."
json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."
htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."
qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/tappy.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/tappy.qhc"
devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/tappy"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/tappy"
@echo "# devhelp"
epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."
latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."
man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."
info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."
linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."
doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."
xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."
././@PaxHeader 0000000 0000000 0000000 00000000033 00000000000 010211 x ustar 00 27 mtime=1640756615.691138
tap.py-3.1/docs/_static/ 0000755 0000765 0000024 00000000000 00000000000 013777 5 ustar 00matt staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1429298097.0
tap.py-3.1/docs/_static/.keep 0000644 0000765 0000024 00000000000 00000000000 014712 0 ustar 00matt staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1454552033.0
tap.py-3.1/docs/alternatives.rst 0000644 0000765 0000024 00000003335 00000000000 015610 0 ustar 00matt staff Alternatives
============
tappy is not the only project that can produce TAP output for Python.
While tappy is a capable TAP producer and consumer,
other projects might be a better fit for you.
The following comparison lists some other Python TAP tools
and lists some of the biggest differences compared to tappy.
pycotap
-------
pycotap is a good tool for when you want TAP output,
but you don't want extra dependencies.
pycotap is a zero dependency TAP producer.
It is so small that you could even embed it into your project.
`Check out the project homepage
`_.
catapult
--------
catapult is a TAP producer.
catapult is also capable of producing TAP-Y and TAP-J
which are YAML and JSON test streams
that are inspired by TAP.
`You can find the catapult source on GitHub
`_.
pytap13
-------
pytap13 is a TAP consumer for TAP version 13.
It parses a TAP stream
and produces test instances that can be inspected.
`pytap13's homepage is on Bitbucket
`_.
bayeux
------
bayeux is a TAP producer
that is designed to work with unittest and unittest2.
`bayeux is on GitLab.
`_.
taptaptap
---------
taptaptap is a TAP producer with a procedural style
similar to Perl.
It also includes a ``TapWriter`` class as a TAP producer.
`Visit the taptaptap homepage
`_.
unittest-tap-reporting
----------------------
unittest-tap-reporting is another zero dependency TAP producer.
`Check it out on GitHub
`_.
If there are other relevant projects,
please post an issue on GitHub
so this comparison page can be updated accordingly.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1640755639.0
tap.py-3.1/docs/conf.py 0000644 0000765 0000024 00000020444 00000000000 013654 0 ustar 00matt staff # -*- coding: utf-8 -*-
#
# tappy documentation build configuration file, created by
# sphinx-quickstart on Tue Mar 11 20:21:22 2014.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.
import sys
import os
sys.path.append(os.path.abspath(".."))
from tap import __version__ # noqa
# 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('.'))
# -- General configuration ------------------------------------------------
# If your documentation needs a minimal Sphinx version, state it here.
# 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",
]
# autodoc settings
autodoc_member_order = "bysource"
# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]
# The suffix of source filenames.
source_suffix = ".rst"
# The encoding of source files.
# source_encoding = 'utf-8-sig'
# The master toctree document.
master_doc = "index"
# General information about the project.
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
# built documents.
#
# The short X.Y version.
version = __version__
# The full version, including alpha/beta/rc tags.
release = __version__
# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None
# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ''
# Else, today_fmt is used as the format for a strftime call.
# 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
# If true, '()' will be appended to :func: etc. cross-reference text.
# 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
# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# 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 = []
# If true, keep warnings as "system message" paragraphs in the built documents.
# 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"
# 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 = {}
# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []
# The name for this set of Sphinx documents. If None, it defaults to
# " v documentation".
# html_title = None
# A shorter title for the navigation bar. Default is the same as html_title.
# 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
# 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
# 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"]
# 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 = []
# 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'
# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True
# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}
# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}
# If false, no module index is generated.
# html_domain_indices = True
# If false, no index is generated.
# html_use_index = True
# If true, the index is split into individual pages for each letter.
# html_split_index = False
# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True
# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True
# If true, "(C) Copyright ..." is shown in the HTML footer. Default is 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 = ''
# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None
# Output file base name for HTML help builder.
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': '',
}
# 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",
),
]
# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None
# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False
# If true, show page references after internal links.
# latex_show_pagerefs = False
# If true, show URL addresses after external links.
# latex_show_urls = False
# Documents to append as an appendix to all manuals.
# latex_appendices = []
# If false, no module index is generated.
# 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)]
# If true, show URL addresses after external links.
# 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",
"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 = []
# If false, no module index is generated.
# texinfo_domain_indices = True
# How to display URL addresses: 'footnote', 'no', or 'inline'.
# texinfo_show_urls = 'footnote'
# If true, do not generate a @detailmenu in the "Top" node's menu.
# texinfo_no_detailmenu = False
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1526390586.0
tap.py-3.1/docs/consumers.rst 0000644 0000765 0000024 00000011126 00000000000 015122 0 ustar 00matt staff TAP Consumers
=============
tappy Tool
----------
The ``tappy`` command line tool is a `TAP consumer
`_.
The tool accepts TAP files or directories containing TAP files
and provides a standard Python ``unittest`` style summary report.
Check out ``tappy -h`` for the complete list of options.
You can also use the tool's shorter alias of ``tap``.
.. code-block:: console
$ tappy *.tap
................F..................................
======================================================================
FAIL:
- The parser extracts a bail out line.
----------------------------------------------------------------------
----------------------------------------------------------------------
Ran 51 tests in 0.002s
FAILED (failures=1)
TAP Stream
~~~~~~~~~~
``tappy`` can read a TAP stream directly STDIN.
This permits any TAP producer to pipe its results to ``tappy``
without generating intermediate output files.
``tappy`` will read from STDIN
when no arguments are provided
or when a dash character is the only argument.
Here is an example of ``nosetests`` piping to ``tappy``:
.. code-block:: console
$ nosetests --with-tap --tap-stream 2>&1 | tappy
......................................................................
...............................................
----------------------------------------------------------------------
Ran 117 tests in 0.003s
OK
In this example,
``nosetests`` puts the TAP stream on STDERR
so it must be redirected to STDOUT
because the Unix pipe expects input on STDOUT.
``tappy`` can use redirected input
from a shell.
.. code-block:: console
$ tappy < TestAdapter.tap
........
----------------------------------------------------------------------
Ran 8 tests in 0.000s
OK
This final example shows ``tappy`` consuming TAP
from Perl's test tool, ``prove``.
The example includes the optional dash character.
.. code-block:: console
$ prove t/array.t -v | tappy -
............
----------------------------------------------------------------------
Ran 12 tests in 0.001s
OK
API
---
In addition to a command line interface, tappy enables programmatic access to
TAP files for users to create their own TAP consumers. This access comes in
two forms:
1. A ``Loader`` class which provides a ``load`` method to load a set of TAP
files into a ``unittest.TestSuite``. The ``Loader`` can receive files or
directories.
.. code-block:: pycon
>>> loader = Loader()
>>> suite = loader.load(['foo.tap', 'bar.tap', 'baz.tap'])
2. A ``Parser`` class to provide a lower level interface. The ``Parser`` can
parse a file via ``parse_file`` and return parsed lines that categorize the
file contents.
.. code-block:: pycon
>>> parser = Parser()
>>> for line in parser.parse_file('foo.tap'):
... # Do whatever you want with the processed line.
... pass
The API specifics are listed below.
.. autoclass:: tap.loader.Loader
:members:
.. autoclass:: tap.parser.Parser
:members:
.. _tap-version-13:
TAP version 13
~~~~~~~~~~~~~~
The specification for TAP version 13 adds support for `yaml blocks `_
to provide additional information about the preceding test. In order to consume
yaml blocks, ``tappy`` requires `pyyaml `_ and
`more-itertools `_ to be installed.
These dependencies are optional. If they are not installed, TAP output will still
be consumed, but any yaml blocks will be parsed as :class:`tap.line.Unknown`. If a
:class:`tap.line.Result` object has an associated yaml block, :attr:`~tap.line.Result.yaml_block`
will return the block converted to a ``dict``. Otherwise, it will return ``None``.
``tappy`` provides a strict interpretation of the specification. A yaml block will
only be associated with a result if it immediately follows that result. Any
:class:`diagnostic ` between a :class:`result ` and a yaml
block will result in the block lines being parsed as :class:`tap.line.Unknown`.
Line Categories
~~~~~~~~~~~~~~~
The parser returns ``Line`` instances. Each line contains different properties
depending on its category.
.. autoclass:: tap.line.Result
:members:
.. autoclass:: tap.line.Plan
:members:
.. autoclass:: tap.line.Diagnostic
:members:
.. autoclass:: tap.line.Bail
:members:
.. autoclass:: tap.line.Version
:members:
.. autoclass:: tap.line.Unknown
:members:
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1640751155.0
tap.py-3.1/docs/contributing.rst 0000644 0000765 0000024 00000002570 00000000000 015616 0 ustar 00matt staff Contributing
============
tappy should be easy to contribute to. If anything is unclear about how to
contribute, please submit an issue on GitHub so that we can fix it!
How
-----
Fork tappy on `GitHub `_ and
`submit a Pull Request `_
when you're ready.
The goal of tappy is to be a TAP-compliant producer and consumer.
If you want to work on an issue
that is outside of the TAP spec,
please write up an issue first,
so we can discuss the change.
Setup
-----
tappy uses the built-in `venv` module.
.. code-block:: console
$ git clone git@github.com:python-tap/tappy.git
$ cd tappy
$ python3 -m venv venv
$ source venv/bin/activate
$ pip install -r requirements-dev.txt
$ # Edit some files and run the tests.
$ pytest
The commands above show how to get a tappy clone configured.
If you've executed those commands
and the test suite passes,
you should be ready to develop.
Guidelines
----------
1. Code uses Black style. Please run it through ``black tap`` to autoformat.
2. Make sure your change works against main with unit tests.
3. Document your change in the ``docs/releases.rst`` file.
4. For first time contributors, please add your name to ``AUTHORS``
so you get attribution for you effort.
This is also to recognize your claim to the copyright in the project.
././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1469904688.0
tap.py-3.1/docs/highlighter.rst 0000644 0000765 0000024 00000001157 00000000000 015405 0 ustar 00matt staff TAP Syntax Highlighter for Pygments
===================================
`Pygments `_ contains an extension for syntax
highlighting of TAP files. Any project that uses Pygments, like
`Sphinx `_, can take advantage of this feature.
This highlighter was initially implemented in tappy.
Since the highlighter was merged into the upstream Pygments project,
tappy is no longer a requirement to get TAP syntax highlighting.
Below is an example usage for Sphinx.
.. code-block:: rst
.. code-block:: tap
1..2
ok 1 - A passing test.
not ok 2 - A failing test.
././@PaxHeader 0000000 0000000 0000000 00000000034 00000000000 010212 x ustar 00 28 mtime=1640756615.6922681
tap.py-3.1/docs/images/ 0000755 0000765 0000024 00000000000 00000000000 013616 5 ustar 00matt staff ././@PaxHeader 0000000 0000000 0000000 00000000026 00000000000 010213 x ustar 00 22 mtime=1469904688.0
tap.py-3.1/docs/images/python-tap.png 0000644 0000765 0000024 00000063664 00000000000 016446 0 ustar 00matt staff ‰PNG
IHDR ‡ ‡ <çJ
bKGD ÿ ÿ ÿ ½§“ pHYs šœ tIMEà)q¡ IDATxÚì½wxÕ•ïÿyËéçèõfÙ’%ËWŒpp7˜fŒ1Ä‚MrIB&7äNîL2¿ü LH2C
À ¸„b0؃qo²%Y²¬ÞΑNïo¹˜£±lu`æ7¿;ûyÎ#=oÙïÞëýîµ¾k½÷+èºÎ@%ðê«4¬Z…øï‡¾ <ËÈÊýÀ4`ì»ï=tˆÖGAú÷k6ëGXÿ•À§ åõõ´?ü0¾-[.lÿ^àjòò±råõÌœàÄ p¹sÃ
4Ìž}q¿~ ø€q€GŒ£GSvâusæ;sáüµiÀ wm?ÌJÉ&méR
ÿô'Σ'©k¦ÇF(›îPœï|‡¼_ÿzÀDþo-íí³Ùµë¼^kêPÃ÷¾wñU|ïÿV
=™DýmêðÀëÒ=ÿrê×uÐ4´H¤ÿú««Wð»ß½ŠÁ`E@íuÅǹ¯úµ@ t-üRd£…ÃçëO$¾ÙG£ƒ^/viÂr|0¥6é~úéÏÕÀì<:ÀX\¢H΃ö ô‹ªA@t:I»õV%%ý·ÿܹelÛ¶™»ï¾Q_ ŒÇú«_䌓‰ôÀÞÙ‰ðËÆç˜¬ë¤þÏÅ9&ëú§ƒÔžs\\¦LÙÃq'ûöÝ<ÑÇ>`Üd]÷P÷çâ“u}Ö mÿ\œc²®ß3œdþ»œ/Ë0› åÿ-Œ‚C…Èçx^dõÇ?GýÁ!Ô¯ô{2?ýüƒÔøìº‘R‚Á.~Ù$¾hpÌ®»ðÀøÇ¿<£(
²,c³Û€H4J"Ç`0 Iñøùwl2™.¼}0v Nx≫Âá0Šªb2‡ÛŸ‡€¦.(þÙÏJF(\ðO@x€ºM€}8•Æ dIÂf³?¤íy½î½HÆŠª¢$“˜ÍfÌf3º®
‡QÙ`˜ÝGýgM#å?þà•W^aÏž=L˜À¾óÌÀ¡êjþòüóX,6lØÀج,UWÓíõrýܹ |tø0ª¦õBÕçëÛmE"‘ï9ºuë[TÄÞO?E’¤á
¿~êOÉåú|Œ€ú‡[·ªªÌ›;—º¦&ž{î9®›9«ÕЦiÖ¯’(rͬóå£#GˆD"2¤„ÓÍÍ<÷ÜsÄãqxঌM@×ùÅLWWË—/çÆoøøJ¿š#Ñúm¼Õ*ÆŽ?ÎÔ©S¹üòËùÙÏ~ÆÉgžaÿ®]üõ¯eRQÝõõlÚ´‰×^x;vPœ™ÉG;v0gÂnßN"‘@„U˜,ÓÝÝÍoû[®˜8‘l“‰÷þö7dY&™LKè‚ `0½FÓ´~ë6‚À`„]EAUw6%IB’¤žz“É$ÓÆŽåÔ¾}üê'?Ayè!222Peàð‚®c4™=~<‚ °k˲²²¸fÚ4Nœ8ÁÒ¥KimmeýúõŒÏÏÇëõrÓM7ñÑGqõÕWóÓŸþ4UU(¢õoéåòòÚ~-\sóDžzê)$IbãÆ|øá‡Üxãlß¾U«V±yóf^zé%œN'Ï<óË–-ãwÞá@’$‰&“ Q‡$I˜Íf ‚ `4ÉÌÌdìØ±Ã#6‘µµµƒ
Ød21þ3_X4M£ªªŠd29h»5M£¤¤„ìììÇq»Ýtvv"B/ ¤€l6›1™LȲ