Skip to content

pycodecov

Test CodeQL Docs codecov pre-commit security: bandit Checked with mypy Ruff pypi python License: MIT

pycodecov is an asynchronous API wrapper for the Codecov API, designed to streamline interaction with Codecov's services in Python. It enables users to leverage Codecov's functionality asynchronously, enhancing performance and usability.

Key Features

  • Asynchronous Operations: Utilizes asyncio and aiohttp for efficient API requests.
  • Data Schema: Built with Python's dataclass for clear and structured data representation.
  • Comprehensive Documentation: Explore detailed documentation for seamless integration and usage.

Installation

pip install pycodecov

Usage

import asyncio
import os

from pycodecov import Codecov

CODECOV_API_TOKEN = os.environ["CODECOV_API_TOKEN"]

async def main():
    async with Codecov(CODECOV_API_TOKEN) as codecov:
        service_owners = await codecov.get_service_owners(Service.GITHUB)
        print(service_owners)

asyncio.run(main())

Table Of Contents

You can start reading the documentation with the following links:

  1. Tutorials
  2. How-To Guides
  3. Reference

Contributing

We welcome contributions to enhance pycodecov! Please review our contributing guidelines. before getting started.

Acknowledgements

We would like to thank Codecov for providing API services and also good documentation for using the API.