{ "info": { "author": "Lukas Prokop", "author_email": "admin@lukas-prokop.at", "bugtrack_url": null, "classifiers": [ "Development Status :: 5 - Production/Stable", "Environment :: Console", "Intended Audience :: Developers", "Intended Audience :: Information Technology", "License :: OSI Approved :: BSD License", "Natural Language :: English", "Operating System :: OS Independent", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Documentation", "Topic :: Software Development :: Testing", "Topic :: System :: Logging", "Topic :: System :: Systems Administration" ], "description": "Documentation\n=============\n\n:name: taptaptap\n:author: Lukas Prokop\n:date: Feb-Apr 2014, Jul 2018\n:license: BSD 3-clause\n:version: 3.0.0\n:issues: http://github.com/meisterluk/taptaptap3/issues\n\nTest Anything Protocol handling for cat lovers \\*rawwr*\n\n.. contents:: Table of contents\n\n``taptaptap3`` provides parsers, writers and APIs to handle the Test Anything Protocol (TAP). The implementation focuses on the most-current TAP version 13. TAP originates from the Perl community, but is a general format to document runs of testsuites. The reference to cats is just a pun for the noise of cats sneaking on floors and \"3\" is part of \"<3\", thus \"lovers\".\n\nCompatibility\n-------------\n\n``taptaptap3`` is only supposed to be working with python 3.5 upwards.\nIt was written for python 2.7 as package `taptaptap `_ and this implementation is a port to python3.\nIt has been tested with Python 3.6.5 on xubuntu 18.04 (Linux 4.15 x86_64) \n\nThe File Format\n---------------\n\nA basic introduction is given by Wikipedia. The format was specified by the Perl community.\n\n* `The Wikipedia article `_\n* `Original specification `_\n* `Test::Harness `_\n\nTestsuite & Examples\n--------------------\n\n``taptaptap3`` comes with a testsuite, which covers many special cases of the TAP format and tests the provided APIs. Please don't hesitate to report any issues_.\n\nYou can run the ``taptaptap3`` testcases yourself using::\n\n ./run.sh\n\nin the tests directory. The testsuite also shows some API usage examples, but I want to provide some here. The procedural API is well-suited if you are in the python REPL::\n\n from taptaptap3.proc import plan, ok, not_ok, out\n plan(tests=10)\n ok('Starting the robot')\n not_ok('Starting the engine')\n not_ok('Find the object', skip='Setup required')\n not_ok('Terminate', skip='Setup required')\n\n out()\n\nThe output looks like this::\n\n 1..10\n ok - Starting the robot\n not ok - Starting the engine\n not ok - Find the object # SKIP Setup required\n not ok - Terminate # SKIP Setup required\n\nBe aware that the state is stored within the module. This is not what you want if you are outside the REPL. The ``TapWriter`` class is more convenient in this case::\n\n import taptaptap3\n\n writer = taptaptap3.TapWriter()\n writer.plan(1, 3)\n writer.ok('This testcase went fine')\n writer.ok('And another one')\n writer.ok('And also the last one')\n\nIf you like python's generators, you want to use ``SimpleTapCreator``::\n\n @taptaptap3.SimpleTapCreator\n def runTests():\n yield True\n yield True\n yield False\n\n print runTests()\n\nGiving us::\n\n 1..3\n ok\n ok\n not ok\n\nOr take a look at the more sophisticated ``TapCreator``. If you are a real expert, you can use ``TapDocument`` directly, which covers all possibilities of TAP.\n\nCommand line tools\n------------------\n\nYou can also invoke ``taptaptap3`` directly from the command line::\n\n python -m taptaptap3.__main__ some_tap_file_to_validate.tap\n\nThis command will parse the file and write the file in a way how it was understood by the module. The exit code indicates its validity:\n\n0\n Everything fine.\n1\n The TAP file is missing some testcases or contains failed testcases.\n2\n A bailout was raised. So the testing environment crashed during the run.\n\nPickling\n--------\n\nAll objects are pickable.\n\nWhen to use ``taptaptap3``\n--------------------------\n\nDoes ``taptaptap3`` suite your needs?\nIt does, if you are looking for a parser and validator for your TAP documents and you don't want to care about details and just need a gentle API.\n\nbest regards,\nmeisterluk\n\n.. _issues: https://github.com/meisterluk/taptaptap\n", "description_content_type": "", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "http://lukas-prokop.at/proj/taptaptap/", "keywords": "", "license": "BSD", "maintainer": "", "maintainer_email": "", "name": "taptaptap3", "package_url": "https://pypi.org/project/taptaptap3/", "platform": "any", "project_url": "https://pypi.org/project/taptaptap3/", "project_urls": { "Homepage": "http://lukas-prokop.at/proj/taptaptap/" }, "release_url": "https://pypi.org/project/taptaptap3/3.0.0/", "requires_dist": null, "requires_python": "", "summary": "Test Anything Protocol handling for cats", "version": "3.0.0" }, "last_serial": 4025906, "releases": { "3.0.0": [ { "comment_text": "", "digests": { "md5": "799a4c92c88575e0572073747009fa97", "sha256": "4fbba8e9785d0b6f6b8e325289a5dad245cf2e8f9d70949f27a6478db2ee8193" }, "downloads": -1, "filename": "taptaptap3-3.0.0.tar.gz", "has_sig": true, "md5_digest": "799a4c92c88575e0572073747009fa97", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19484, "upload_time": "2018-07-03T11:48:30", "url": "https://files.pythonhosted.org/packages/94/4e/abd6e9fe63c54fb4adf9ac103ceefdffb7e6a446c9f28715dd400e68d56b/taptaptap3-3.0.0.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "799a4c92c88575e0572073747009fa97", "sha256": "4fbba8e9785d0b6f6b8e325289a5dad245cf2e8f9d70949f27a6478db2ee8193" }, "downloads": -1, "filename": "taptaptap3-3.0.0.tar.gz", "has_sig": true, "md5_digest": "799a4c92c88575e0572073747009fa97", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 19484, "upload_time": "2018-07-03T11:48:30", "url": "https://files.pythonhosted.org/packages/94/4e/abd6e9fe63c54fb4adf9ac103ceefdffb7e6a446c9f28715dd400e68d56b/taptaptap3-3.0.0.tar.gz" } ] }