pycodecov


Namepycodecov JSON
Version 0.1.0 PyPI version JSON
download
home_pagehttps://github.com/kiraware/pycodecov
SummaryPython Codecov API Wrapper
upload_time2024-09-14 11:11:57
maintainerKira
docs_urlNone
authorKira
requires_python<4.0,>=3.12
licenseMIT
keywords codecov api
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # pycodecov

[![Test](https://github.com/kiraware/pycodecov/workflows/Test/badge.svg)](https://github.com/kiraware/pycodecov/actions/workflows/test.yml)
[![CodeQL](https://github.com/kiraware/pycodecov/workflows/CodeQL/badge.svg)](https://github.com/kiraware/pycodecov/actions/workflows/codeql.yml)
[![Docs](https://readthedocs.org/projects/pycodecov/badge/?version=latest)](https://pycodecov.readthedocs.io/en/latest/?badge=latest)
[![codecov](https://codecov.io/gh/kiraware/pycodecov/graph/badge.svg?token=PH6EUFT4V0)](https://codecov.io/gh/kiraware/pycodecov)
[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)
[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)
[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)
[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)
[![pypi](https://img.shields.io/pypi/v/pycodecov.svg)](https://pypi.org/project/pycodecov/)
[![python](https://img.shields.io/pypi/pyversions/pycodecov.svg)](https://pypi.org/project/pycodecov/)
[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/MIT/)

`pycodecov` is an asynchronous API wrapper for the
[Codecov API](https://docs.codecov.com/reference/overview), 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](https://pycodecov.readthedocs.io/en/latest/) for seamless integration and usage.

## Installation

```bash
pip install pycodecov
```

## Usage

```python
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](https://pycodecov.readthedocs.io/en/latest/).

## Contributing

We welcome contributions to enhance pycodecov! Please review our
[contributing guidelines](https://pycodecov.readthedocs.io/en/latest/how-to-guides/#contributing).
before getting started.

## Acknowledgements

We would like to thank [Codecov](https://about.codecov.io/)
for providing API services and also good documentation for
using the API.

Raw data

            {
    "_id": null,
    "home_page": "https://github.com/kiraware/pycodecov",
    "name": "pycodecov",
    "maintainer": "Kira",
    "docs_url": null,
    "requires_python": "<4.0,>=3.12",
    "maintainer_email": "kiraware@github.com",
    "keywords": "codecov, api",
    "author": "Kira",
    "author_email": "kiraware@github.com",
    "download_url": "https://files.pythonhosted.org/packages/0a/12/f94102de8b84c8e6a1766e07bad1ef1f890deca4eb355a911251cdf1c2e6/pycodecov-0.1.0.tar.gz",
    "platform": null,
    "description": "# pycodecov\n\n[![Test](https://github.com/kiraware/pycodecov/workflows/Test/badge.svg)](https://github.com/kiraware/pycodecov/actions/workflows/test.yml)\n[![CodeQL](https://github.com/kiraware/pycodecov/workflows/CodeQL/badge.svg)](https://github.com/kiraware/pycodecov/actions/workflows/codeql.yml)\n[![Docs](https://readthedocs.org/projects/pycodecov/badge/?version=latest)](https://pycodecov.readthedocs.io/en/latest/?badge=latest)\n[![codecov](https://codecov.io/gh/kiraware/pycodecov/graph/badge.svg?token=PH6EUFT4V0)](https://codecov.io/gh/kiraware/pycodecov)\n[![pre-commit](https://img.shields.io/badge/pre--commit-enabled-brightgreen?logo=pre-commit&logoColor=white)](https://github.com/pre-commit/pre-commit)\n[![security: bandit](https://img.shields.io/badge/security-bandit-yellow.svg)](https://github.com/PyCQA/bandit)\n[![Checked with mypy](http://www.mypy-lang.org/static/mypy_badge.svg)](http://mypy-lang.org/)\n[![Ruff](https://img.shields.io/endpoint?url=https://raw.githubusercontent.com/astral-sh/ruff/main/assets/badge/v2.json)](https://github.com/astral-sh/ruff)\n[![pypi](https://img.shields.io/pypi/v/pycodecov.svg)](https://pypi.org/project/pycodecov/)\n[![python](https://img.shields.io/pypi/pyversions/pycodecov.svg)](https://pypi.org/project/pycodecov/)\n[![License: MIT](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/license/MIT/)\n\n`pycodecov` is an asynchronous API wrapper for the\n[Codecov API](https://docs.codecov.com/reference/overview), designed\nto streamline interaction with Codecov's services in Python. It\nenables users to leverage Codecov's functionality asynchronously,\nenhancing performance and usability.\n\n## Key Features\n\n- **Asynchronous Operations:** Utilizes `asyncio` and `aiohttp` for efficient API requests.\n- **Data Schema:** Built with Python's `dataclass` for clear and structured data representation.\n- **Comprehensive Documentation:** Explore detailed [documentation](https://pycodecov.readthedocs.io/en/latest/) for seamless integration and usage.\n\n## Installation\n\n```bash\npip install pycodecov\n```\n\n## Usage\n\n```python\nimport asyncio\nimport os\n\nfrom pycodecov import Codecov\nfrom pycodecov.enums import Service\n\nCODECOV_API_TOKEN = os.environ[\"CODECOV_API_TOKEN\"]\n\nasync def main():\n    async with Codecov(CODECOV_API_TOKEN) as codecov:\n        service_owners = await codecov.get_service_owners(Service.GITHUB)\n        print(service_owners)\n\nasyncio.run(main())\n```\n\n## Docs\n\nYou can start reading the documentation [here](https://pycodecov.readthedocs.io/en/latest/).\n\n## Contributing\n\nWe welcome contributions to enhance pycodecov! Please review our\n[contributing guidelines](https://pycodecov.readthedocs.io/en/latest/how-to-guides/#contributing).\nbefore getting started.\n\n## Acknowledgements\n\nWe would like to thank [Codecov](https://about.codecov.io/)\nfor providing API services and also good documentation for\nusing the API.\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "Python Codecov API Wrapper",
    "version": "0.1.0",
    "project_urls": {
        "Bug Tracker": "https://github.com/kiraware/pycodecov/issues",
        "Documentation": "https://pycodecov.readthedocs.io/en/latest/",
        "Homepage": "https://github.com/kiraware/pycodecov",
        "Repository": "https://github.com/kiraware/pycodecov"
    },
    "split_keywords": [
        "codecov",
        " api"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "3cc1cbba099ac8dd23ea148af68fef3546c9b5d3ffea087b72a70cb93fd58f62",
                "md5": "381d512067b5097142f9fd564d1dee51",
                "sha256": "3e5c97e4816e5de682e693f097d097390a6c0484be72cdabfd0d5b0dbea761d8"
            },
            "downloads": -1,
            "filename": "pycodecov-0.1.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "381d512067b5097142f9fd564d1dee51",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": "<4.0,>=3.12",
            "size": 57366,
            "upload_time": "2024-09-14T11:11:54",
            "upload_time_iso_8601": "2024-09-14T11:11:54.460163Z",
            "url": "https://files.pythonhosted.org/packages/3c/c1/cbba099ac8dd23ea148af68fef3546c9b5d3ffea087b72a70cb93fd58f62/pycodecov-0.1.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "0a12f94102de8b84c8e6a1766e07bad1ef1f890deca4eb355a911251cdf1c2e6",
                "md5": "e87f3863665287446186b71e143e9e89",
                "sha256": "2f83db628026fc66f47c9afb7d460bf5bfe9f38b55d99ebd9faf0558248cd4e6"
            },
            "downloads": -1,
            "filename": "pycodecov-0.1.0.tar.gz",
            "has_sig": false,
            "md5_digest": "e87f3863665287446186b71e143e9e89",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": "<4.0,>=3.12",
            "size": 24884,
            "upload_time": "2024-09-14T11:11:57",
            "upload_time_iso_8601": "2024-09-14T11:11:57.007919Z",
            "url": "https://files.pythonhosted.org/packages/0a/12/f94102de8b84c8e6a1766e07bad1ef1f890deca4eb355a911251cdf1c2e6/pycodecov-0.1.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-09-14 11:11:57",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "kiraware",
    "github_project": "pycodecov",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "pycodecov"
}
Kira
Elapsed time: 1.29065s