gRPC Typing Stubs for Python
============================
This is a PEP-561-compliant stub-only package which provides type information of
[gRPC](https://grpc.io>).
Install using pip:
pip install grpc-stubs
Tests (courtesy of [pytest-mypy-plugins](https://github.com/typeddjango/pytest-mypy-plugins>):
pip install -r requirements-dev.txt
./tools.sh test
## Call for assistance
There are several areas where `grpc-stubs` could use some TLC. If you'd like to
help with any of this, please reach out.
### Maintainers
It's unlikely I'll be returning to grpc full-time for the foreseeable future,
and my knowledge of the minutiae fades with each passing year. If anyone wishes
to assume maintainership of this project ongoing, please reach out. An attempt to
merge into typeshed is underway here: https://github.com/python/typeshed/pull/11204
## Python Support
grpc-stubs is tested with 3.7 or later, but ideally it should support Python 3.6 as
grpc still supports this. Python 3.6 had to be disabled in the tests due to
various cascading fiascos and a lack of time to contend with them. Feel free
to submit a PR if you'd like to see it returned, or open issues. Ensure that
you supply an MRE as per the contributing guidelines below.
## Contributing
### Minimum Reproducible Examples (MRE)
Unfortunately, due to the fussy nature of `grpc` and its dependencies, and the
huge amount of time required to construct a context in which to verify and
debug issues, starting from 2022-04-16, fairly strict issue and pull request
templates have been added.
Minimum Reproducible Examples are now a hard requirement for pull requests that
touch the typing surface, and a soft requirement for issues. PRs without a
functioning MRE transfer the burden entirely from the contributor to the
maintainer, and I simply don't have time to do the deep-dives required to build
out MREs from scratch when issues inevitably crop up. PRs without a trivially
executable MRE will be closed without further consideration; of course you are
always welcome to reopen once you have added a verified MRE!
### Tests
This project uses a slightly old version of
https://github.com/TypedDjango/pytest-mypy-plugins for testing. All new
contributions will be required to include at least one, but probably multiple
tests. See `typesafety/test_*.yml`.
### Code-generated stubs
PRs containing auto-generated stubs have had to be reverted several times due
to issues. Starting from 2022-04-16, autogenerated stubs from `mypy-protobuf`
will not be accepted without extensive tests, and will not be accepted with
edit warnings left in. It's ok to use this tool to seed stubs, but not to
refresh stubs - once contributed to this repo, the stubs should be presumed to
have been written by hand.
## Other Very Useful Typed Python Stuff
- https://github.com/TypedDjango
- https://github.com/typeddjango/pytest-mypy-plugins
- https://github.com/typeddjango/awesome-python-stubs
Raw data
{
"_id": null,
"home_page": "https://github.com/shabbyrobe/grpc-stubs",
"name": "grpc-stubs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Blake Williams",
"author_email": "code@shabbyrobe.org",
"download_url": "https://files.pythonhosted.org/packages/55/8d/14c6b8c2fa5d82ffe96aed53b1c38e2a9fb6a57c5836966545f3080e5adc/grpc-stubs-1.53.0.5.tar.gz",
"platform": null,
"description": "gRPC Typing Stubs for Python\n============================\n\nThis is a PEP-561-compliant stub-only package which provides type information of\n[gRPC](https://grpc.io>).\n\nInstall using pip:\n\n pip install grpc-stubs\n\n\nTests (courtesy of [pytest-mypy-plugins](https://github.com/typeddjango/pytest-mypy-plugins>):\n\n pip install -r requirements-dev.txt\n ./tools.sh test\n\n\n## Call for assistance\n\nThere are several areas where `grpc-stubs` could use some TLC. If you'd like to\nhelp with any of this, please reach out.\n\n\n### Maintainers\n\nIt's unlikely I'll be returning to grpc full-time for the foreseeable future,\nand my knowledge of the minutiae fades with each passing year. If anyone wishes\nto assume maintainership of this project ongoing, please reach out. An attempt to\nmerge into typeshed is underway here: https://github.com/python/typeshed/pull/11204\n\n\n## Python Support\n\ngrpc-stubs is tested with 3.7 or later, but ideally it should support Python 3.6 as\ngrpc still supports this. Python 3.6 had to be disabled in the tests due to\nvarious cascading fiascos and a lack of time to contend with them. Feel free\nto submit a PR if you'd like to see it returned, or open issues. Ensure that\nyou supply an MRE as per the contributing guidelines below.\n\n\n## Contributing\n\n### Minimum Reproducible Examples (MRE)\n\nUnfortunately, due to the fussy nature of `grpc` and its dependencies, and the\nhuge amount of time required to construct a context in which to verify and\ndebug issues, starting from 2022-04-16, fairly strict issue and pull request\ntemplates have been added.\n\nMinimum Reproducible Examples are now a hard requirement for pull requests that\ntouch the typing surface, and a soft requirement for issues. PRs without a\nfunctioning MRE transfer the burden entirely from the contributor to the\nmaintainer, and I simply don't have time to do the deep-dives required to build\nout MREs from scratch when issues inevitably crop up. PRs without a trivially\nexecutable MRE will be closed without further consideration; of course you are\nalways welcome to reopen once you have added a verified MRE!\n\n\n### Tests\n\nThis project uses a slightly old version of\nhttps://github.com/TypedDjango/pytest-mypy-plugins for testing. All new\ncontributions will be required to include at least one, but probably multiple\ntests. See `typesafety/test_*.yml`.\n\n\n### Code-generated stubs\n\nPRs containing auto-generated stubs have had to be reverted several times due\nto issues. Starting from 2022-04-16, autogenerated stubs from `mypy-protobuf`\nwill not be accepted without extensive tests, and will not be accepted with\nedit warnings left in. It's ok to use this tool to seed stubs, but not to\nrefresh stubs - once contributed to this repo, the stubs should be presumed to\nhave been written by hand.\n\n\n## Other Very Useful Typed Python Stuff\n\n- https://github.com/TypedDjango\n- https://github.com/typeddjango/pytest-mypy-plugins\n- https://github.com/typeddjango/awesome-python-stubs\n\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Mypy stubs for gRPC",
"version": "1.53.0.5",
"project_urls": {
"Homepage": "https://github.com/shabbyrobe/grpc-stubs"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e086147d2ccaf9b4b81407734b9abc1152aff39836e8e05be3bf069f9374c021",
"md5": "3d0e8f832c8644ea9f5a055317003fff",
"sha256": "04183fb65a1b166a1febb9627e3d9647d3926ccc2dfe049fe7b6af243428dbe1"
},
"downloads": -1,
"filename": "grpc_stubs-1.53.0.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "3d0e8f832c8644ea9f5a055317003fff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 16497,
"upload_time": "2023-12-28T02:13:27",
"upload_time_iso_8601": "2023-12-28T02:13:27.556126Z",
"url": "https://files.pythonhosted.org/packages/e0/86/147d2ccaf9b4b81407734b9abc1152aff39836e8e05be3bf069f9374c021/grpc_stubs-1.53.0.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "558d14c6b8c2fa5d82ffe96aed53b1c38e2a9fb6a57c5836966545f3080e5adc",
"md5": "5d60b47dd737d1f6e203d630d42879da",
"sha256": "3e1b642775cbc3e0c6332cfcedfccb022176db87e518757bef3a1241397be406"
},
"downloads": -1,
"filename": "grpc-stubs-1.53.0.5.tar.gz",
"has_sig": false,
"md5_digest": "5d60b47dd737d1f6e203d630d42879da",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 14259,
"upload_time": "2023-12-28T02:13:29",
"upload_time_iso_8601": "2023-12-28T02:13:29.190903Z",
"url": "https://files.pythonhosted.org/packages/55/8d/14c6b8c2fa5d82ffe96aed53b1c38e2a9fb6a57c5836966545f3080e5adc/grpc-stubs-1.53.0.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-28 02:13:29",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "shabbyrobe",
"github_project": "grpc-stubs",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "grpc-stubs"
}
JSON
