mypy-boto3-builder


Namemypy-boto3-builder JSON
Version 8.7.0 PyPI version JSON
download
home_pageNone
SummaryType annotations generator for types-boto3, boto3-stubs, types-aiobotocore, and types-aioboto3.
upload_time2024-12-19 23:07:26
maintainerNone
docs_urlNone
authorNone
requires_python>=3.12
licenseMIT License Copyright (c) 2023 Vlad Emelianov Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords boto3 type-annotations pyright mypy boto3-stubs
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # Mypy Boto3 Builder

[![PyPI - mypy-boto3-builder](https://img.shields.io/pypi/v/mypy-boto3-builder.svg?color=blue&label=mypy-boto3-builder)](https://pypi.org/project/mypy-boto3-builder)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/boto3-stubs.svg?color=blue)](https://pypi.org/project/boto3-stubs)
[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue&label=builder%20docs)](https://youtype.github.io/mypy_boto3_builder/)

[![PyPI - boto3-stubs](https://img.shields.io/pypi/v/boto3-stubs.svg?color=blue&label=boto3-stubs)](https://pypi.org/project/boto3-stubs)
[![PyPI - boto3](https://img.shields.io/pypi/v/boto3.svg?color=blue&label=boto3)](https://pypi.org/project/boto3)
[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue&label=boto3-stubs%20docs)](https://youtype.github.io/boto3_stubs_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/boto3-stubs)](https://pepy.tech/project/boto3-stubs)
[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/boto3-stubs?color=blue)](https://pypistats.org/packages/boto3-stubs)

[![PyPI - types-aiobotocore](https://img.shields.io/pypi/v/types-aiobotocore.svg?color=blue&label=types-aiobotocore)](https://pypi.org/project/types-aiobotocore)
[![PyPI - aiobotocore](https://img.shields.io/pypi/v/aiobotocore.svg?color=blue&label=aiobotocore)](https://pypi.org/project/aiobotocore)
[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue&label=types-aiobotocore%20docs)](https://youtype.github.io/types_aiobotocore_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore)](https://pepy.tech/project/types-aiobotocore)
[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/types-aiobotocore?color=blue)](https://pypistats.org/packages/types-aiobotocore)

[![PyPI - types-aioboto3](https://img.shields.io/pypi/v/types-aioboto3.svg?color=blue&label=types-aioboto3)](https://pypi.org/project/types-aioboto3)
[![PyPI - aioboto3](https://img.shields.io/pypi/v/aioboto3.svg?color=blue&label=aioboto3)](https://pypi.org/project/aioboto3)
[![Docs](https://img.shields.io/readthedocs/types-aioboto3.svg?color=blue&label=types-aioboto3%20docs)](https://youtype.github.io/types_aioboto3_docs/)
[![PyPI - Downloads](https://static.pepy.tech/badge/types-aioboto3)](https://pepy.tech/project/types-aioboto3)
[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/types-aioboto3?color=blue)](https://pypistats.org/packages/types-aioboto3)

![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)

Type annotations generator for [types-boto3](https://pypi.org/project/types-boto3/),
[boto3-stubs](https://pypi.org/project/boto3-stubs/),
[types-aiobotocore](https://pypi.org/project/types-aiobotocore/),
and [types-aioboto3](https://pypi.org/project/types-aioboto3/) projects.
Compatible with
[VSCode](https://code.visualstudio.com/),
[PyCharm](https://www.jetbrains.com/pycharm/),
[Emacs](https://www.gnu.org/software/emacs/),
[Sublime Text](https://www.sublimetext.com/),
[mypy](https://github.com/python/mypy),
[pyright](https://github.com/microsoft/pyright)
and other tools.

See how it helps to find and fix potential bugs:

![types-boto3 demo](https://raw.githubusercontent.com/youtype/mypy_boto3_builder/main/demo.gif)

Do you want more? Check the [documentation](https://youtype.github.io/boto3_stubs_docs/) and use `boto3` like a pro!

- [Mypy Boto3 Builder](#mypy-boto3-builder)
  - [Quickstart](#quickstart)
  - [Type annotations documentation](#type-annotations-documentation)
  - [Builder documentation](#builder-documentation)
  - [Versioning](#versioning)
  - [Latest changes](#latest-changes)

## Quickstart

- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)
- Run `uvx mypy_boto3_builder`
- Answer some questions, get your custom package
- Install a generated package

## Type annotations documentation

- If you use `boto3` or `botocore`, follow [types-boto3 documentation](https://youtype.github.io/types_boto3_docs/)
- For `aiobotocore` follow [types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/)
- For `aioboto3` follow [types-aioboto3 documentation](https://youtype.github.io/types_aioboto3_docs/)

## Builder documentation

- [How to use pre-built libraries](./docsmd/pre_build.md)
- [How builder works](./docsmd/how_it_works.md)
- [How to build type annotations](./docsmd/how_to_build.md)
- [Development](./docsmd/development.md)
- [Contributors](./docsmd/thank_you.md)

## Versioning

`mypy_boto3_builder` version is not related to `boto3` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/).

## Latest changes

Full changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases).

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "mypy-boto3-builder",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.12",
    "maintainer_email": null,
    "keywords": "boto3, type-annotations, pyright, mypy, boto3-stubs",
    "author": null,
    "author_email": "Vlad Emelianov <vlad.emelianov.nz@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/9b/c6/c963ff1808ff4a9939d6969c4b1ce5a7a4edb052720f7884afee4f5f90e7/mypy_boto3_builder-8.7.0.tar.gz",
    "platform": null,
    "description": "# Mypy Boto3 Builder\n\n[![PyPI - mypy-boto3-builder](https://img.shields.io/pypi/v/mypy-boto3-builder.svg?color=blue&label=mypy-boto3-builder)](https://pypi.org/project/mypy-boto3-builder)\n[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/boto3-stubs.svg?color=blue)](https://pypi.org/project/boto3-stubs)\n[![Docs](https://img.shields.io/readthedocs/mypy-boto3-builder.svg?color=blue&label=builder%20docs)](https://youtype.github.io/mypy_boto3_builder/)\n\n[![PyPI - boto3-stubs](https://img.shields.io/pypi/v/boto3-stubs.svg?color=blue&label=boto3-stubs)](https://pypi.org/project/boto3-stubs)\n[![PyPI - boto3](https://img.shields.io/pypi/v/boto3.svg?color=blue&label=boto3)](https://pypi.org/project/boto3)\n[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue&label=boto3-stubs%20docs)](https://youtype.github.io/boto3_stubs_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/boto3-stubs)](https://pepy.tech/project/boto3-stubs)\n[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/boto3-stubs?color=blue)](https://pypistats.org/packages/boto3-stubs)\n\n[![PyPI - types-aiobotocore](https://img.shields.io/pypi/v/types-aiobotocore.svg?color=blue&label=types-aiobotocore)](https://pypi.org/project/types-aiobotocore)\n[![PyPI - aiobotocore](https://img.shields.io/pypi/v/aiobotocore.svg?color=blue&label=aiobotocore)](https://pypi.org/project/aiobotocore)\n[![Docs](https://img.shields.io/readthedocs/types-aiobotocore.svg?color=blue&label=types-aiobotocore%20docs)](https://youtype.github.io/types_aiobotocore_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-aiobotocore)](https://pepy.tech/project/types-aiobotocore)\n[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/types-aiobotocore?color=blue)](https://pypistats.org/packages/types-aiobotocore)\n\n[![PyPI - types-aioboto3](https://img.shields.io/pypi/v/types-aioboto3.svg?color=blue&label=types-aioboto3)](https://pypi.org/project/types-aioboto3)\n[![PyPI - aioboto3](https://img.shields.io/pypi/v/aioboto3.svg?color=blue&label=aioboto3)](https://pypi.org/project/aioboto3)\n[![Docs](https://img.shields.io/readthedocs/types-aioboto3.svg?color=blue&label=types-aioboto3%20docs)](https://youtype.github.io/types_aioboto3_docs/)\n[![PyPI - Downloads](https://static.pepy.tech/badge/types-aioboto3)](https://pepy.tech/project/types-aioboto3)\n[![PyPI - Monthly Downloads](https://img.shields.io/pypi/dm/types-aioboto3?color=blue)](https://pypistats.org/packages/types-aioboto3)\n\n![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png)\n\nType annotations generator for [types-boto3](https://pypi.org/project/types-boto3/),\n[boto3-stubs](https://pypi.org/project/boto3-stubs/),\n[types-aiobotocore](https://pypi.org/project/types-aiobotocore/),\nand [types-aioboto3](https://pypi.org/project/types-aioboto3/) projects.\nCompatible with\n[VSCode](https://code.visualstudio.com/),\n[PyCharm](https://www.jetbrains.com/pycharm/),\n[Emacs](https://www.gnu.org/software/emacs/),\n[Sublime Text](https://www.sublimetext.com/),\n[mypy](https://github.com/python/mypy),\n[pyright](https://github.com/microsoft/pyright)\nand other tools.\n\nSee how it helps to find and fix potential bugs:\n\n![types-boto3 demo](https://raw.githubusercontent.com/youtype/mypy_boto3_builder/main/demo.gif)\n\nDo you want more? Check the [documentation](https://youtype.github.io/boto3_stubs_docs/) and use `boto3` like a pro!\n\n- [Mypy Boto3 Builder](#mypy-boto3-builder)\n  - [Quickstart](#quickstart)\n  - [Type annotations documentation](#type-annotations-documentation)\n  - [Builder documentation](#builder-documentation)\n  - [Versioning](#versioning)\n  - [Latest changes](#latest-changes)\n\n## Quickstart\n\n- Install [uv](https://docs.astral.sh/uv/getting-started/installation/)\n- Run `uvx mypy_boto3_builder`\n- Answer some questions, get your custom package\n- Install a generated package\n\n## Type annotations documentation\n\n- If you use `boto3` or `botocore`, follow [types-boto3 documentation](https://youtype.github.io/types_boto3_docs/)\n- For `aiobotocore` follow [types-aiobotocore documentation](https://youtype.github.io/types_aiobotocore_docs/)\n- For `aioboto3` follow [types-aioboto3 documentation](https://youtype.github.io/types_aioboto3_docs/)\n\n## Builder documentation\n\n- [How to use pre-built libraries](./docsmd/pre_build.md)\n- [How builder works](./docsmd/how_it_works.md)\n- [How to build type annotations](./docsmd/how_to_build.md)\n- [Development](./docsmd/development.md)\n- [Contributors](./docsmd/thank_you.md)\n\n## Versioning\n\n`mypy_boto3_builder` version is not related to `boto3` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/).\n\n## Latest changes\n\nFull changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Vlad Emelianov  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Type annotations generator for types-boto3, boto3-stubs, types-aiobotocore, and types-aioboto3.",
    "version": "8.7.0",
    "project_urls": {
        "Changelog": "https://github.com/youtype/mypy_boto3_builder/releases",
        "Documentation": "https://youtype.github.io/mypy_boto3_builder/",
        "Homepage": "https://github.com/youtype/mypy_boto3_builder",
        "Issues": "https://github.com/youtype/mypy_boto3_builder/issues",
        "Repository": "https://github.com/youtype/mypy_boto3_builder"
    },
    "split_keywords": [
        "boto3",
        " type-annotations",
        " pyright",
        " mypy",
        " boto3-stubs"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "d92adb0a22db19b4ad13b7ad224612846ec17363e3adb3a1de2af15b6a9dbf0e",
                "md5": "9c089aee1396407d52139bc00eddedda",
                "sha256": "e56e0c64f8d6b51f1e8726408edd137ac5f514f2a4d591bac0cf8ed497a065b1"
            },
            "downloads": -1,
            "filename": "mypy_boto3_builder-8.7.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c089aee1396407d52139bc00eddedda",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.12",
            "size": 308023,
            "upload_time": "2024-12-19T23:07:22",
            "upload_time_iso_8601": "2024-12-19T23:07:22.925251Z",
            "url": "https://files.pythonhosted.org/packages/d9/2a/db0a22db19b4ad13b7ad224612846ec17363e3adb3a1de2af15b6a9dbf0e/mypy_boto3_builder-8.7.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "9bc6c963ff1808ff4a9939d6969c4b1ce5a7a4edb052720f7884afee4f5f90e7",
                "md5": "b09927e25c1feadca6c78254959b4576",
                "sha256": "a5cf32c5d12e12e9220955a3f8be1ad7bb471906de2c0e69e40f2aeb4b460938"
            },
            "downloads": -1,
            "filename": "mypy_boto3_builder-8.7.0.tar.gz",
            "has_sig": false,
            "md5_digest": "b09927e25c1feadca6c78254959b4576",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.12",
            "size": 163038,
            "upload_time": "2024-12-19T23:07:26",
            "upload_time_iso_8601": "2024-12-19T23:07:26.346621Z",
            "url": "https://files.pythonhosted.org/packages/9b/c6/c963ff1808ff4a9939d6969c4b1ce5a7a4edb052720f7884afee4f5f90e7/mypy_boto3_builder-8.7.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-12-19 23:07:26",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "youtype",
    "github_project": "mypy_boto3_builder",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "mypy-boto3-builder"
}
        
Elapsed time: 9.08932s