Skip to main content

Python Codecov API Wrapper

Project description

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
from pycodecov.enums import Service

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())

Docs

You can start reading the documentation here.

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.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pycodecov-0.1.0.tar.gz (24.9 kB view hashes)

Uploaded Source

Built Distribution

pycodecov-0.1.0-py3-none-any.whl (57.4 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page