pytest-telegram


Namepytest-telegram JSON
Version 1.2.1 PyPI version JSON
download
home_pagehttps://github.com/rad96/pytest-telegram
SummaryPytest to Telegram reporting plugin
upload_time2024-04-25 08:17:33
maintainerNone
docs_urlNone
authorArtem Ryabkov
requires_pythonNone
licenseMIT license
keywords pytest py.test telegram
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            =================
pytest-telegram
=================

.. image:: https://img.shields.io/pypi/v/pytest-telegram.svg
        :target: https://pypi.python.org/pypi/pytest-telegram

.. image:: https://pyup.io/repos/github/rad96/pytest-telegram/shield.svg
        :target: https://pyup.io/repos/github/rad96/pytest-telegram/
        :alt: Updates
     


Pytest to Telegram reporting plugin


* Free software: MIT license


Requirements
------------

* Requests



Installation
------------

You can install "pytest-telegram" via `pip`_::

    $ pip install pytest-telegram


Usage
-----
* Use this plugin by running pytest normally and use the following options to customize report:


>>> telegram:
    --telegram_id=CHAT_ID
                        Id of telegram chat
    --telegram_token=BOT_TOKEN
                        Telegram Bot token
    --telegram_report_url=URL
                        Link for test report, optional
    --telegram_custom_text=TEXT
                        Custom text, will be added for message, supports '\n' as newline, optional
    --telegram_success_sticker_id=FILE_ID
                        File id of telegram sticker which will be attach to Success report
    --telegram_fail_sticker_id=FILE_ID
                        File id of telegram sticker which will be attach to Failed report
    --telegram_disable_stickers
                        Disables stickers for bot
    --telegram_list_failed
                        Bot will send failed test names

Example
-------
    $ pytest ./tests --telegram_id=100559633 --telegram_token=123:qwe --telegram_report_url=http://path.to.report --telegram_custom_text="This is custom text"

Success report:

.. image:: https://user-images.githubusercontent.com/2121715/101268709-7ba55200-3777-11eb-9552-cc24983419f2.png
        :target: https://user-images.githubusercontent.com/2121715/101268709-7ba55200-3777-11eb-9552-cc24983419f2.png

Failed report:

.. image:: https://user-images.githubusercontent.com/2121715/101268724-a8596980-3777-11eb-8d0e-38e0621b3006.png
        :target: https://user-images.githubusercontent.com/2121715/101268724-a8596980-3777-11eb-8d0e-38e0621b3006.png

Issues
------

If you encounter any problems, please `file an issue`_ along with a detailed description.

.. _`file an issue`: https://github.com/rad96/pytest-telegram/issues
.. _`pip`: https://pypi.python.org/pypi/pip/


=======
History
=======

1.0.0
------------------

* Initial release.

1.0.3
------------------

* Fixed multiline custom text.

1.1.0
------------------

* Added option for disabling stickers.
* Added option for list failed tests.

1.2.0
------------------

* Added test session time to report.

            

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/rad96/pytest-telegram",
    "name": "pytest-telegram",
    "maintainer": null,
    "docs_url": null,
    "requires_python": null,
    "maintainer_email": null,
    "keywords": "pytest, py.test, telegram",
    "author": "Artem Ryabkov",
    "author_email": "rad964@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/52/c6/778436ec54c3576d7b60249e43fbf700350dd1d6afcff0973020bb6b97e8/pytest_telegram-1.2.1.tar.gz",
    "platform": null,
    "description": "=================\npytest-telegram\n=================\n\n.. image:: https://img.shields.io/pypi/v/pytest-telegram.svg\n        :target: https://pypi.python.org/pypi/pytest-telegram\n\n.. image:: https://pyup.io/repos/github/rad96/pytest-telegram/shield.svg\n        :target: https://pyup.io/repos/github/rad96/pytest-telegram/\n        :alt: Updates\n     \n\n\nPytest to Telegram reporting plugin\n\n\n* Free software: MIT license\n\n\nRequirements\n------------\n\n* Requests\n\n\n\nInstallation\n------------\n\nYou can install \"pytest-telegram\" via `pip`_::\n\n    $ pip install pytest-telegram\n\n\nUsage\n-----\n* Use this plugin by running pytest normally and use the following options to customize report:\n\n\n>>> telegram:\n    --telegram_id=CHAT_ID\n                        Id of telegram chat\n    --telegram_token=BOT_TOKEN\n                        Telegram Bot token\n    --telegram_report_url=URL\n                        Link for test report, optional\n    --telegram_custom_text=TEXT\n                        Custom text, will be added for message, supports '\\n' as newline, optional\n    --telegram_success_sticker_id=FILE_ID\n                        File id of telegram sticker which will be attach to Success report\n    --telegram_fail_sticker_id=FILE_ID\n                        File id of telegram sticker which will be attach to Failed report\n    --telegram_disable_stickers\n                        Disables stickers for bot\n    --telegram_list_failed\n                        Bot will send failed test names\n\nExample\n-------\n    $ pytest ./tests --telegram_id=100559633 --telegram_token=123:qwe --telegram_report_url=http://path.to.report --telegram_custom_text=\"This is custom text\"\n\nSuccess report:\n\n.. image:: https://user-images.githubusercontent.com/2121715/101268709-7ba55200-3777-11eb-9552-cc24983419f2.png\n        :target: https://user-images.githubusercontent.com/2121715/101268709-7ba55200-3777-11eb-9552-cc24983419f2.png\n\nFailed report:\n\n.. image:: https://user-images.githubusercontent.com/2121715/101268724-a8596980-3777-11eb-8d0e-38e0621b3006.png\n        :target: https://user-images.githubusercontent.com/2121715/101268724-a8596980-3777-11eb-8d0e-38e0621b3006.png\n\nIssues\n------\n\nIf you encounter any problems, please `file an issue`_ along with a detailed description.\n\n.. _`file an issue`: https://github.com/rad96/pytest-telegram/issues\n.. _`pip`: https://pypi.python.org/pypi/pip/\n\n\n=======\nHistory\n=======\n\n1.0.0\n------------------\n\n* Initial release.\n\n1.0.3\n------------------\n\n* Fixed multiline custom text.\n\n1.1.0\n------------------\n\n* Added option for disabling stickers.\n* Added option for list failed tests.\n\n1.2.0\n------------------\n\n* Added test session time to report.\n",
    "bugtrack_url": null,
    "license": "MIT license",
    "summary": "Pytest to Telegram reporting plugin",
    "version": "1.2.1",
    "project_urls": {
        "Homepage": "https://github.com/rad96/pytest-telegram"
    },
    "split_keywords": [
        "pytest",
        " py.test",
        " telegram"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "28f8c6c26bccd30e794f85da68c64e7e5ed56e669bd886e5e676372e0fb0f991",
                "md5": "3cbbf15c9b3f8cec934cca4e9de3682d",
                "sha256": "4f2171316b6e4b20149498be9bd4339b01b9758013c4b90cfa770d402283166c"
            },
            "downloads": -1,
            "filename": "pytest_telegram-1.2.1-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "3cbbf15c9b3f8cec934cca4e9de3682d",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 5038,
            "upload_time": "2024-04-25T08:17:31",
            "upload_time_iso_8601": "2024-04-25T08:17:31.394965Z",
            "url": "https://files.pythonhosted.org/packages/28/f8/c6c26bccd30e794f85da68c64e7e5ed56e669bd886e5e676372e0fb0f991/pytest_telegram-1.2.1-py2.py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52c6778436ec54c3576d7b60249e43fbf700350dd1d6afcff0973020bb6b97e8",
                "md5": "4126c765f7e3fb93adeb43cf1ab3b51c",
                "sha256": "825fc963c9818a2fb7e7e5e296e2c6562cd973338cd7c0e13afc1c1407f6136e"
            },
            "downloads": -1,
            "filename": "pytest_telegram-1.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4126c765f7e3fb93adeb43cf1ab3b51c",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 5587,
            "upload_time": "2024-04-25T08:17:33",
            "upload_time_iso_8601": "2024-04-25T08:17:33.200701Z",
            "url": "https://files.pythonhosted.org/packages/52/c6/778436ec54c3576d7b60249e43fbf700350dd1d6afcff0973020bb6b97e8/pytest_telegram-1.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-04-25 08:17:33",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "rad96",
    "github_project": "pytest-telegram",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "tox": true,
    "lcname": "pytest-telegram"
}
        
Elapsed time: 0.24618s