Metadata-Version: 2.1
Name: pytest-codecov
Version: 0.6.0
Summary: Pytest plugin for uploading pytest-cov results to codecov.io
Author-email: David Salvisberg <david.salvisberg@seantis.ch>
Maintainer-email: David Salvisberg <david.salvisberg@seantis.ch>
License: 
        The MIT License (MIT)
        
        Copyright (c) 2021 David Salvisberg
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in
        all copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
        THE SOFTWARE.
        
Project-URL: Repository, https://github.com/seantis/pytest-codecov
Classifier: Framework :: Pytest
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Testing
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Classifier: License :: OSI Approved :: MIT License
Requires-Python: >=3.8
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: pytest>=4.6.0
Requires-Dist: pytest-cov>=2.11.0
Requires-Dist: coverage[toml]>=5.2.1
Requires-Dist: requests>=2.25.1
Provides-Extra: git
Requires-Dist: GitPython>=3.1.15; extra == "git"

==============
pytest-codecov
==============

.. image:: https://img.shields.io/pypi/v/pytest-codecov.svg
    :target: https://pypi.org/project/pytest-codecov
    :alt: PyPI version

.. image:: https://img.shields.io/pypi/pyversions/pytest-codecov.svg
    :target: https://pypi.org/project/pytest-codecov
    :alt: Python versions

.. image:: https://github.com/seantis/pytest-codecov/actions/workflows/python-tox.yaml/badge.svg
    :target: https://github.com/seantis/pytest-codecov/actions
    :alt: Tests

.. image:: https://codecov.io/gh/seantis/pytest-codecov/branch/master/graph/badge.svg?token=CwujQmq61X
    :target: https://codecov.io/gh/seantis/pytest-codecov
    :alt: Codecov.io

Pytest plugin for uploading `pytest-cov`_ results to `codecov.io`_

----

This `pytest`_ plugin was generated with `Cookiecutter`_ along with `@hackebrot`_'s `cookiecutter-pytest-plugin`_ template.


Features
--------

* Uploads coverage results to `codecov.io` at the end of the tests.
* Detects current project slug, branch and commit using `GitPython`, when installed and running inside a git repository.


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

* `pytest-cov`_
* `requests`_
* `GitPython`_ (Optional, for auto detecting some meta data)


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

You can install "pytest-codecov" via `pip`_ from `PyPI`_::

    $ pip install pytest-codecov


Usage
-----

* Add :code:`--codecov` to pytest arguments to enable upload
* Supply your Codecov token either through :code:`--codecov-token=` or `CODECOV_TOKEN` environment variable. Refer to your CI's documentation to properly secure that token.


Contributing
------------
Contributions are very welcome. Tests can be run with `tox`_, please ensure
the coverage at least stays the same before you submit a pull request.


License
-------

Distributed under the terms of the `MIT`_ license, "pytest-codecov" is free and open source software


Issues
------

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

.. _`Cookiecutter`: https://github.com/audreyr/cookiecutter
.. _`@hackebrot`: https://github.com/hackebrot
.. _`MIT`: http://opensource.org/licenses/MIT
.. _`cookiecutter-pytest-plugin`: https://github.com/pytest-dev/cookiecutter-pytest-plugin
.. _`file an issue`: https://github.com/seantis/pytest-codecov/issues
.. _`pytest`: https://github.com/pytest-dev/pytest
.. _`tox`: https://tox.readthedocs.io/en/latest/
.. _`pip`: https://pypi.org/project/pip/
.. _`PyPI`: https://pypi.org/project
.. _`pytest-cov`: https://github.com/pytest-dev/pytest-cov
.. _`codecov.io`: https://codecov.io
.. _`requests`: https://github.com/psf/requests
.. _`GitPython`: https://github.com/gitpython-developers/GitPython
