# aiogithubapi
[](https://codecov.io/gh/ludeeus/aiogithubapi)
[](https://pypi.org/project/aiogithubapi)
_Asynchronous Python client for the GitHub API_
This is not a full client for the API (Have you seen it, it's huge), and will probably never be.
Things are added when needed or requested.
If something you need is missing please raise [a feature request to have it added](https://github.com/ludeeus/aiogithubapi/issues/new?assignees=&labels=enhancement&template=feature_request.md) or [create a PR 🎉](#contribute).
For examples on how to use it see the [tests directory](./tests).
## Install
```bash
python3 -m pip install aiogithubapi
```
## Project transition
**Note: This project is currently in a transition phase.**
In august 2021 a new API interface was introduced (in [#42](https://github.com/ludeeus/aiogithubapi/pull/42)). With that addition, all parts of the old interface is now considered deprecated.
Which includes:
- The [`aiogithubapi.common`](./aiogithubapi/common) module
- The [`aiogithubapi.legacy`](./aiogithubapi/legacy) module
- The [`aiogithubapi.objects`](./aiogithubapi/objects) module
- All classes starting with `AIOGitHub`
- The `async_call_api` function in the [`aiogithubapi.helpers.py`](./aiogithubapi/helpers.py) file
- The `GitHubDevice` class in `aiogithubapi`, replaced with `GitHubDeviceAPI`
- The `GitHub` class in `aiogithubapi`, replaced with `GitHubAPI`
Later this year (2022), warning logs will start to be emitted for deprecated code.
Early next year (2023), the old code will be removed.
## Contribute
**All** contributions are welcome!
1. Fork the repository
2. Clone the repository locally and open the devcontainer or use GitHub codespaces
3. Do your changes
4. Lint the files with `make lint`
5. Ensure all tests passes with `make test`
6. Ensure 100% coverage with `make coverage`
7. Commit your work, and push it to GitHub
8. Create a PR against the `main` branch
Raw data
{
"_id": null,
"home_page": "https://github.com/ludeeus/aiogithubapi",
"name": "aiogithubapi",
"maintainer": "Ludeeus",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "ludeeus@ludeeus.dev",
"keywords": "",
"author": "Ludeeus",
"author_email": "ludeeus@ludeeus.dev",
"download_url": "https://files.pythonhosted.org/packages/a1/ec/21db20d5dde5e58effe2ce47c29fd77f6a7b0c89c674ac15a49c39bba879/aiogithubapi-23.11.0.tar.gz",
"platform": null,
"description": "# aiogithubapi\n\n[](https://codecov.io/gh/ludeeus/aiogithubapi)\n\n[](https://pypi.org/project/aiogithubapi)\n\n\n_Asynchronous Python client for the GitHub API_\n\nThis is not a full client for the API (Have you seen it, it's huge), and will probably never be.\nThings are added when needed or requested.\n\nIf something you need is missing please raise [a feature request to have it added](https://github.com/ludeeus/aiogithubapi/issues/new?assignees=&labels=enhancement&template=feature_request.md) or [create a PR \ud83c\udf89](#contribute).\n\nFor examples on how to use it see the [tests directory](./tests).\n\n## Install\n\n```bash\npython3 -m pip install aiogithubapi\n```\n\n## Project transition\n\n**Note: This project is currently in a transition phase.**\n\nIn august 2021 a new API interface was introduced (in [#42](https://github.com/ludeeus/aiogithubapi/pull/42)). With that addition, all parts of the old interface is now considered deprecated.\nWhich includes:\n\n- The [`aiogithubapi.common`](./aiogithubapi/common) module\n- The [`aiogithubapi.legacy`](./aiogithubapi/legacy) module\n- The [`aiogithubapi.objects`](./aiogithubapi/objects) module\n- All classes starting with `AIOGitHub`\n- The `async_call_api` function in the [`aiogithubapi.helpers.py`](./aiogithubapi/helpers.py) file\n- The `GitHubDevice` class in `aiogithubapi`, replaced with `GitHubDeviceAPI`\n- The `GitHub` class in `aiogithubapi`, replaced with `GitHubAPI`\n\nLater this year (2022), warning logs will start to be emitted for deprecated code.\n\nEarly next year (2023), the old code will be removed.\n\n## Contribute\n\n**All** contributions are welcome!\n\n1. Fork the repository\n2. Clone the repository locally and open the devcontainer or use GitHub codespaces\n3. Do your changes\n4. Lint the files with `make lint`\n5. Ensure all tests passes with `make test`\n6. Ensure 100% coverage with `make coverage`\n7. Commit your work, and push it to GitHub\n8. Create a PR against the `main` branch\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Asynchronous Python client for the GitHub API",
"version": "23.11.0",
"project_urls": {
"Homepage": "https://github.com/ludeeus/aiogithubapi",
"Repository": "https://github.com/ludeeus/aiogithubapi"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "26328601ab25b7a0662ef32c18ef7ba2b7ae96cfc5ac08a29c88018877f79eea",
"md5": "cf1c9f2a80917f65384bb56a92237439",
"sha256": "75d5bfc4c542e2530a3b4c6da8554d972ebb1ac1962d404e00225d9331824276"
},
"downloads": -1,
"filename": "aiogithubapi-23.11.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cf1c9f2a80917f65384bb56a92237439",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 71107,
"upload_time": "2023-11-03T07:30:55",
"upload_time_iso_8601": "2023-11-03T07:30:55.325170Z",
"url": "https://files.pythonhosted.org/packages/26/32/8601ab25b7a0662ef32c18ef7ba2b7ae96cfc5ac08a29c88018877f79eea/aiogithubapi-23.11.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a1ec21db20d5dde5e58effe2ce47c29fd77f6a7b0c89c674ac15a49c39bba879",
"md5": "2737542c6877597f09172595de06df10",
"sha256": "773230c72c62c04ef78dcde5d94302bb22e20005f7dbad99e6425d4c379d82c2"
},
"downloads": -1,
"filename": "aiogithubapi-23.11.0.tar.gz",
"has_sig": false,
"md5_digest": "2737542c6877597f09172595de06df10",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 39903,
"upload_time": "2023-11-03T07:30:57",
"upload_time_iso_8601": "2023-11-03T07:30:57.093480Z",
"url": "https://files.pythonhosted.org/packages/a1/ec/21db20d5dde5e58effe2ce47c29fd77f6a7b0c89c674ac15a49c39bba879/aiogithubapi-23.11.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-03 07:30:57",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ludeeus",
"github_project": "aiogithubapi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "aiogithubapi"
}
JSON
