{"id":26482009,"url":"https://github.com/kiwitcms/tap-plugin","last_synced_at":"2025-07-15T12:34:14.282Z","repository":{"id":34053196,"uuid":"167533129","full_name":"kiwitcms/tap-plugin","owner":"kiwitcms","description":"Test Anything Protocol (TAP) plugin for Kiwi TCMS","archived":false,"fork":false,"pushed_at":"2025-02-03T20:58:52.000Z","size":104,"stargazers_count":9,"open_issues_count":3,"forks_count":3,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-06-29T20:29:36.803Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"http://kiwitcms.org","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kiwitcms.png","metadata":{"files":{"readme":"README.rst","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"custom":["https://kiwitcms.org/#subscriptions"],"github":["kiwitcms"],"patreon":null,"open_collective":"kiwitcms","ko_fi":null,"tidelift":"pypi/kiwitcms","community_bridge":null,"liberapay":null,"issuehunt":null,"otechie":null}},"created_at":"2019-01-25T10:55:12.000Z","updated_at":"2025-03-10T14:45:42.000Z","dependencies_parsed_at":"2024-01-29T20:15:11.949Z","dependency_job_id":"797fd617-f148-4a7f-8d83-2a033e921a2c","html_url":"https://github.com/kiwitcms/tap-plugin","commit_stats":{"total_commits":173,"total_committers":9,"mean_commits":19.22222222222222,"dds":0.2890173410404624,"last_synced_commit":"9720012e13445442a56f5539bc0f4af86f9a2cc8"},"previous_names":[],"tags_count":18,"template":false,"template_full_name":null,"purl":"pkg:github/kiwitcms/tap-plugin","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwitcms%2Ftap-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwitcms%2Ftap-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwitcms%2Ftap-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwitcms%2Ftap-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kiwitcms","download_url":"https://codeload.github.com/kiwitcms/tap-plugin/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kiwitcms%2Ftap-plugin/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":264321988,"owners_count":23590586,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2025-03-20T03:36:37.593Z","updated_at":"2025-07-15T12:34:14.234Z","avatar_url":"https://github.com/kiwitcms.png","language":"Python","funding_links":["https://kiwitcms.org/#subscriptions","https://github.com/sponsors/kiwitcms","https://opencollective.com/kiwitcms","https://tidelift.com/funding/github/pypi/kiwitcms","https://tidelift.com/badges/package/pypi/kiwitcms-tap-plugin","https://tidelift.com/subscription/pkg/pypi-kiwitcms-tap-plugin?utm_source=pypi-kiwitcms-tap-plugin\u0026utm_medium=github\u0026utm_campaign=readme"],"categories":[],"sub_categories":[],"readme":"Test Anything Protocol (TAP) plugin for Kiwi TCMS\n=================================================\n\n.. image:: https://img.shields.io/pypi/v/kiwitcms-tap-plugin.svg\n    :target: https://pypi.org/project/kiwitcms-tap-plugin\n    :alt: PyPI version\n\n.. image:: https://travis-ci.org/kiwitcms/tap-plugin.svg?branch=master\n    :target: https://travis-ci.org/kiwitcms/tap-plugin\n    :alt: Travis CI\n\n.. image:: https://coveralls.io/repos/github/kiwitcms/tap-plugin/badge.svg?branch=master\n    :target: https://coveralls.io/github/kiwitcms/tap-plugin?branch=master\n    :alt: Code coverage\n\n.. image:: https://pyup.io/repos/github/kiwitcms/tap-plugin/shield.svg\n    :target: https://pyup.io/repos/github/kiwitcms/tap-plugin/\n    :alt: Python updates\n\n.. image:: https://img.shields.io/badge/kiwi%20tcms-results-9ab451.svg\n    :target: https://tcms.kiwitcms.org/plan/6/\n    :alt: TP for kiwitcms/tap-plugin (master)\n\n.. image:: https://tidelift.com/badges/package/pypi/kiwitcms-tap-plugin\n    :target: https://tidelift.com/subscription/pkg/pypi-kiwitcms-tap-plugin?utm_source=pypi-kiwitcms-tap-plugin\u0026utm_medium=github\u0026utm_campaign=readme\n    :alt: Tidelift\n\n.. image:: https://opencollective.com/kiwitcms/tiers/sponsor/badge.svg?label=sponsors\u0026color=brightgreen\n   :target: https://opencollective.com/kiwitcms#contributors\n   :alt: Become a sponsor\n\n.. image:: https://img.shields.io/twitter/follow/KiwiTCMS.svg\n    :target: https://twitter.com/KiwiTCMS\n    :alt: Kiwi TCMS on Twitter\n\nThis package allows you to read Test Anything Protocol (TAP) files and\nsend the results to `Kiwi TCMS \u003chttp://kiwitcms.org\u003e`_.\n\n\nInstallation\n------------\n\n::\n\n    pip install kiwitcms-tap-plugin\n\n\nNote: this plugin should be installed on the system executing your automated tests\nor a separate system whose task is to parse the results and import them into Kiwi TCMS.\nThis is usually not your Kiwi TCMS container!\n\n\nConfiguration and environment\n-----------------------------\n\nMinimal config file `~/.tcms.conf`::\n\n    [tcms]\n    url = https://tcms.server/xml-rpc/\n    username = your-username\n    password = your-password\n\n\nFor more info see `tcms-api docs \u003chttps://tcms-api.readthedocs.io\u003e`_.\n\nThis plugin is only concerned with parsing the TAP format and executing\n``tcms-api`` functions which will create/reuse test cases, test plans and test runs.\n``tcms-api`` behavior is controlled via environment variables.\n\nFor example inside\n`.github/workflows/testing.yml \u003chttps://github.com/kiwitcms/tap-plugin/blob/master/.github/workflows/testing.yml\u003e`_\nthis looks like::\n\n    export TCMS_PRODUCT=$GITHUB_REPOSITORY\n    export TCMS_PRODUCT_VERSION=$(echo $GITHUB_REF | sed \"s|refs/heads/||\" | sed \"s|refs/||\" | sed \"s|/merge||\")\n    export TCMS_BUILD=$(echo $GITHUB_SHA | cut -c1-7)\n\n\nFurther documentation and behavior specification can be found\n`here \u003chttps://tcms-api.readthedocs.io/en/latest/modules/tcms_api.plugin_helpers.html\u003e`_.\n\nThe above configuration creates a separate TestPlan for each branch, for example\n`TP-6: [TAP] Plan for kiwitcms/tap-plugin (master) \u003chttps://tcms.kiwitcms.org/plan/6/\u003e`_,\na separate TestPlan for each pull request (recording possible multiple test runs) and\nseparate TestPlan and TestRun for each tag on GitHub! ``tcms-api`` has default behavior\nfor Travis CI and Jenkins and allows endless configuration via environment variables.\n\n\nUsage\n-----\n\n::\n\n    # define environment variables\n    tcms-tap-plugin /path/to/results.tap\n\n\nChangelog\n---------\n\nv12.8.1 (22 Dec 2023)\n~~~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 12.7 to 12.8.1\n- Relax dependency requirement towards tcms-api for easier upgrade\n\n\nv12.7 (11 Dec 2023)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 11.3 to 12.7\n- Update README to avoid confusions where to install this package. Closes\n  `Issue #62 \u003chttps://github.com/kiwitcms/tap-plugin/issues/62\u003e`_\n- Build and test with Python 3.11\n- Reformat source code with Black\n- Enable CodeQL for code scanning\n- Small refactoring internally\n\n\nv11.3 (17 May 2022)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api from 11.2 to 11.3\n- Print information about created recrods if ``-v`` or ``--verbose``\n  is specified on the command line\n- Allow multiple TAP files to be specified on the command line. Fixes\n  `Issue #57 \u003chttps://github.com/kiwitcms/tap-plugin/issues/57\u003e`_\n\n\nv11.2 (15 May 2022)\n~~~~~~~~~~~~~~~~~~~\n\n- Update tap.py from 3.0 to 3.1\n- Update tcms-api from 11.0 to 11.2. Closes\n  `Issue #5 \u003chttps://github.com/kiwitcms/tap-plugin/issues/5\u003e`_ and\n  `Issue #13 \u003chttps://github.com/kiwitcms/tap-plugin/issues/13\u003e`_\n- Fix bug with traceback not being posted as comment.\n  `Issue #48 \u003chttps://github.com/kiwitcms/tap-plugin/issues/48\u003e`_\n\n\nv11.0 (05 Dec 2021)\n~~~~~~~~~~~~~~~~~~~\n\n- Future compatible with upcoming Kiwi TCMS v11.0\n- Update tcms-api from 10.0 to 11.0\n- Pylint fixes\n\n\nv10.0 (02 Mar 2021)\n~~~~~~~~~~~~~~~~~~~\n\n- Compatible with Kiwi TCMS v10.0\n- Update tcms-api to 10.0\n\n\nv9.0 (13 Jan 2021)\n~~~~~~~~~~~~~~~~~~\n\n- Compatible with Kiwi TCMS v9.0\n- Update tcms-api to 9.0\n- Resolve a dependency issue in tests\n\n\nv8.4 (28 Oct 2020)\n~~~~~~~~~~~~~~~~~~\n\n- Update tcms-api to 8.6.0\n\n\nv8.3 (10 Apr 2020)\n~~~~~~~~~~~~~~~~~~\n\n- Update to\n  `tcms-api v8.3.0 \u003chttps://github.com/kiwitcms/tcms-api/#v830-10-april-2020\u003e`_\n  which uses ``gssapi`` for Kerberos\n- Requires MIT Kerberos for Windows if installed on Windows\n\n\nv8.2 (03 Apr 2020)\n~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.2 or later!\n\n- Update to tcms-api==8.2.0\n- Patch for changed return value in\n  ``plugin_helpers.Backend.test_case_get_or_create()``\n- Call ``plugin_helpers.backend.finish_test_run()`` when done. Fixes\n  `Issue #9 \u003chttps://github.com/kiwitcms/tap-plugin/issues/9\u003e`_\n\n\nv8.0.1 (10 February 2020)\n~~~~~~~~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.0 or later!\n\n- Update to tcms-api==8.0.1\n\n\nv8.0 (09 February 2020)\n~~~~~~~~~~~~~~~~~~~~~~~\n\nThis version works only with Kiwi TCMS v8.0 or later!\n\n- Adjust plugin due to API changes in Kiwi TCMS v8.0\n- Update ``tap.py`` from 2.6.2 to 3.0\n- Require ``tcms-api\u003e=8.0``\n\n\nv0.5 (07 January 2020)\n~~~~~~~~~~~~~~~~~~~~~~\n\n- Update ``tap.py`` dependency from 2.6.1 to 2.6.2\n\n\nv0.4 (23 September 2019)\n~~~~~~~~~~~~~~~~~~~~~~~~\n\n- Include traceback from TAP file as TE comment. Fixes\n  `Issue #7 \u003chttps://github.com/kiwitcms/tap-plugin/issues/7\u003e`_\n  (Christophe CHAUVET)\n\n\nv0.3 (10 April 2019)\n~~~~~~~~~~~~~~~~~~~~\n\n- Works with Kiwi TCMS v6.7 or newer\n- Uses new names of API methods\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiwitcms%2Ftap-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkiwitcms%2Ftap-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkiwitcms%2Ftap-plugin/lists"}