# teamcity-messages-extra
![license](https://img.shields.io/badge/License-MIT-blue.svg)
[![tests](https://github.com/fopina/teamcity-messages-extra/workflows/tests/badge.svg)](https://github.com/fopina/teamcity-messages-extra/actions?query=workflow%3Atests)
[![Current version on PyPi](https://img.shields.io/pypi/v/teamcity-messages-extra)](https://pypi.org/project/teamcity-messages-extra/)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/teamcity-messages-extra)
[teamcity-messages](https://pypi.org/project/teamcity-messages/) ([JetBrains official package](https://github.com/JetBrains/teamcity-messages/)) has no activity for over one year.
This package will try to address some of the missing features by extending official one. It's not a fork, [teamcity-messages](https://pypi.org/project/teamcity-messages/) is an actual dependency so that any dependency analysis tools (eg, [dependency-check](https://owasp.org/www-project-dependency-check/)) properly identify it.
## Usage
Just import `teamcity_extra` instead of `teamcity`. Everything from the official package will be available, plus the `extra`.
Instead of:
```python
from teamcity.messages import TeamcityServiceMessages
```
Use:
```python
from teamcity_extra.messages import TeamcityServiceMessages
```
## Extra
### TeamcityServiceMessages.testMetadata
[testMetadata service message](https://www.jetbrains.com/help/teamcity/reporting-test-metadata.html#Reporting+Additional+Test+Data)
### TeamcityServiceMessages.buildStatisticValue
[buildStatisticValue service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Reporting+Build+Statistics)
### TeamcityServiceMessages.addBuildTag
[addBuildTag service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Adding+and+Removing+Build+Tags)
### TeamcityServiceMessages.addBuildTag
[removeBuildTag service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Adding+and+Removing+Build+Tags)
### TeamcityServiceMessages.NO_OUTPUT
[NO_OUTPUT output](https://github.com/fopina/teamcity-messages-extra/pull/7) will make all service message calls / methods in `TeamcityServiceMessages` to not print anything.
This allows for simpler code when teamcity output is optional
```python
from teamcity_extra.messages import TeamcityServiceMessages, NO_OUTPUT
# None is the default value (stdout)
tsm = TeamcityServiceMessages(output=None if should_report_to_teamcity() else NO_OUTPUT)
with tsm.test('thisTest'):
doWhatever()
```
Raw data
{
"_id": null,
"home_page": null,
"name": "teamcity-messages-extra",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": null,
"keywords": "unittest, teamcity, test, nose, behave, flake8, py.test, pytest, jetbrains",
"author": null,
"author_email": "Filipe Pina <fopina@duck.com>",
"download_url": "https://files.pythonhosted.org/packages/30/25/dcce5f12cd87a949e8e50a2b61fb2f7d67a5345e78d6518c0f38f2058821/teamcity_messages_extra-1.1.0.tar.gz",
"platform": null,
"description": "# teamcity-messages-extra\n\n![license](https://img.shields.io/badge/License-MIT-blue.svg)\n[![tests](https://github.com/fopina/teamcity-messages-extra/workflows/tests/badge.svg)](https://github.com/fopina/teamcity-messages-extra/actions?query=workflow%3Atests)\n[![Current version on PyPi](https://img.shields.io/pypi/v/teamcity-messages-extra)](https://pypi.org/project/teamcity-messages-extra/)\n![PyPI - Python Version](https://img.shields.io/pypi/pyversions/teamcity-messages-extra)\n\n[teamcity-messages](https://pypi.org/project/teamcity-messages/) ([JetBrains official package](https://github.com/JetBrains/teamcity-messages/)) has no activity for over one year.\n\nThis package will try to address some of the missing features by extending official one. It's not a fork, [teamcity-messages](https://pypi.org/project/teamcity-messages/) is an actual dependency so that any dependency analysis tools (eg, [dependency-check](https://owasp.org/www-project-dependency-check/)) properly identify it.\n\n## Usage\n\nJust import `teamcity_extra` instead of `teamcity`. Everything from the official package will be available, plus the `extra`.\n\nInstead of:\n```python\nfrom teamcity.messages import TeamcityServiceMessages\n```\nUse:\n```python\nfrom teamcity_extra.messages import TeamcityServiceMessages\n```\n\n## Extra\n\n### TeamcityServiceMessages.testMetadata\n\n[testMetadata service message](https://www.jetbrains.com/help/teamcity/reporting-test-metadata.html#Reporting+Additional+Test+Data)\n\n### TeamcityServiceMessages.buildStatisticValue\n\n[buildStatisticValue service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Reporting+Build+Statistics)\n\n### TeamcityServiceMessages.addBuildTag\n\n[addBuildTag service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Adding+and+Removing+Build+Tags)\n\n### TeamcityServiceMessages.addBuildTag\n\n[removeBuildTag service message](https://www.jetbrains.com/help/teamcity/service-messages.html#Adding+and+Removing+Build+Tags)\n\n### TeamcityServiceMessages.NO_OUTPUT\n\n[NO_OUTPUT output](https://github.com/fopina/teamcity-messages-extra/pull/7) will make all service message calls / methods in `TeamcityServiceMessages` to not print anything.\n\nThis allows for simpler code when teamcity output is optional\n\n```python\nfrom teamcity_extra.messages import TeamcityServiceMessages, NO_OUTPUT\n\n# None is the default value (stdout)\ntsm = TeamcityServiceMessages(output=None if should_report_to_teamcity() else NO_OUTPUT)\n\nwith tsm.test('thisTest'):\n doWhatever()\n```\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Python Unit Test Reporting to TeamCity (EXTENDED)",
"version": "1.1.0",
"project_urls": {
"homepage": "https://github.com/fopina/teamcity-messages-extra"
},
"split_keywords": [
"unittest",
" teamcity",
" test",
" nose",
" behave",
" flake8",
" py.test",
" pytest",
" jetbrains"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e7cbe03b4ad72990b0025ee5997bca7fd78c973e6f1bf9e77274a724dc234c08",
"md5": "d5af77d88de87f24afa4095ba81f3c4a",
"sha256": "cb66ddf767a8d61e70cde4d767faa223e5ba7b10e4fdae6499c59750c85907a1"
},
"downloads": -1,
"filename": "teamcity_messages_extra-1.1.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "d5af77d88de87f24afa4095ba81f3c4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 4027,
"upload_time": "2024-07-25T11:07:03",
"upload_time_iso_8601": "2024-07-25T11:07:03.174648Z",
"url": "https://files.pythonhosted.org/packages/e7/cb/e03b4ad72990b0025ee5997bca7fd78c973e6f1bf9e77274a724dc234c08/teamcity_messages_extra-1.1.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3025dcce5f12cd87a949e8e50a2b61fb2f7d67a5345e78d6518c0f38f2058821",
"md5": "f130dbd0c54ab1c57f1c8a3a01c6e3dd",
"sha256": "b2c741bbe3b277bd512979a4e32ee4c351e403eab9a747559bb7fbfb50c8949b"
},
"downloads": -1,
"filename": "teamcity_messages_extra-1.1.0.tar.gz",
"has_sig": false,
"md5_digest": "f130dbd0c54ab1c57f1c8a3a01c6e3dd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 7834,
"upload_time": "2024-07-25T11:07:04",
"upload_time_iso_8601": "2024-07-25T11:07:04.430109Z",
"url": "https://files.pythonhosted.org/packages/30/25/dcce5f12cd87a949e8e50a2b61fb2f7d67a5345e78d6518c0f38f2058821/teamcity_messages_extra-1.1.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-25 11:07:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "fopina",
"github_project": "teamcity-messages-extra",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "teamcity-messages-extra"
}