# Boto3 type annotations generator
[](https://pypi.org/project/mypy-boto3-builder)
[](https://pypi.org/project/boto3-stubs)
[](https://youtype.github.io/mypy_boto3_builder/)
[](https://pypi.org/project/boto3-stubs)
[](https://pypi.org/project/boto3)
[](https://youtype.github.io/boto3_stubs_docs/)
[](https://pepy.tech/project/boto3-stubs)
[](https://pypi.org/project/types-aiobotocore)
[](https://pypi.org/project/aiobotocore)
[](https://youtype.github.io/types_aiobotocore_docs/)
[](https://pepy.tech/project/types-aiobotocore)
[](https://pypi.org/project/types-aioboto3)
[](https://pypi.org/project/aioboto3)
[](https://youtype.github.io/types_aioboto3_docs/)
[](https://pepy.tech/project/types-aioboto3)
Type annotations builder for [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:
Do you want more? Check the [documentation](https://youtype.github.io/boto3_stubs_docs/) and use `boto3` like a pro!
- [Boto3 type annotations generator](#boto3-type-annotations-generator)
- [Using built libraries](#using-built-libraries)
- [boto3](#boto3)
- [aiobotocore](#aiobotocore)
- [aioboto3](#aioboto3)
- [How to build type annotations](#how-to-build-type-annotations)
- [Locally](#locally)
- [With Docker image](#with-docker-image)
- [Development](#development)
- [Versioning](#versioning)
- [Latest changes](#latest-changes)
- [Thank you](#thank-you)
- [Toolset](#toolset)
- [Contributors](#contributors)
## Using built libraries
### boto3
Check [boto3-stubs](https://pypi.org/project/boto3-stubs/) project for installation
and usage instructions.
If you use VSCode, add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
If not, just install `boto3-stubs` with `pip`:
```bash
python -m pip install 'boto3-stubs[essential]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'boto3-stubs-lite[essential]'
# do not forget to install mypy or pyright
```
That's it! You should already have code completion and type checking in your IDE.
### aiobotocore
Check [types-aiobotocore](https://pypi.org/project/types-aiobotocore/) project for installation
and usage instructions.
Or just install `types-aiobotocore` with `pip`:
```bash
python -m pip install 'types-aiobotocore[essential]'
# Lite version does not provide session.create_client overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aiobotocore-lite[essential]'
# do not forget to install mypy or pyright
```
Ready to go! Enjoy code completion and type checking in your `aiobotocore` project.
### aioboto3
Check [types-aioboto3](https://pypi.org/project/types-aioboto3/) project for installation
and usage instructions.
Or just install `types-aioboto3` with `pip`:
```bash
python -m pip install 'types-aioboto3[essential]'
# Lite version does not provide session.client/resource overloads
# it is more RAM-friendly, but requires explicit type annotations
python -m pip install 'types-aioboto3-lite[essential]'
# do not forget to install mypy or pyright
```
Whoa! All `aioboto3` methods and attributes are now type annotated and even code completion works.
## How to build type annotations
### Locally
```bash
# Install preferred version of `boto3`
python -m pip install boto3==1.16.25 botocore==1.19.25
# Install `mypy-boto3-builder`
python -m pip install mypy-boto3-builder
# Build all packages in mypy_boto3_output directory
python -m mypy_boto3_builder mypy_boto3_output
# Or specify required services explicitly
python -m mypy_boto3_builder mypy_boto3_output -s ec2 s3
# Install custom `boto3-stubs` packages
cd mypy_boto3_output
python -m pip install -e ./mypy_boto3_ec2_package
python -m pip install -e ./mypy_boto3_s3_package
python -m pip install -e ./boto3_stubs_package
```
### With Docker image
- Install [Docker](https://docs.docker.com/install/)
- Pull latest `mypy_boto3_builder` version and tag it
```bash
docker pull docker.pkg.github.com/youtype/mypy_boto3_builder/mypy_boto3_builder_stable:latest
docker tag docker.pkg.github.com/youtype/mypy_boto3_builder/mypy_boto3_builder_stable:latest mypy_boto3_builder
```
- Generate stubs in `output` directory
```bash
mkdir output
# generate stubs for all services
docker run -v `pwd`/output:/output -ti mypy_boto3_builder_stable
# generate stubs for s3 service
docker run -v `pwd`/output:/output -ti mypy_boto3_builder_stable -s s3
# generate stubs for a specific boto3 version
docker run -e BOTO3_VERSION=1.16.25 BOTOCORE_VERSION=1.19.25 -v `pwd`/output:/output -ti mypy_boto3_builder_stable
```
- Install packages from `output` directory as described above
## Development
- Install Python 3.11+, ideally with [pyenv](https://github.com/pyenv/pyenv)
- Install [poetry](https://python-poetry.org/): `pip install poetry`
- Install dependencies: `poetry install`
- Use scripts for repo to check if everything works: `./scripts/build.sh`
- Run manual pre-commit: `./scripts/before_commit.sh`
## 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).
## Thank you
### Toolset
- [black](https://github.com/psf/black) developers for an awesome formatting tool
- [Timothy Edmund Crosley](https://github.com/timothycrosley) for
[isort](https://github.com/PyCQA/isort) and how flexible it is
- [mypy](https://github.com/python/mypy) developers for doing all dirty work for us
- [pyright](https://github.com/microsoft/pyright) team for the new era of typed Python
- [ruff](https://github.com/astral-sh/ruff) developers for the fastest swiss knife for Python
### Contributors
- [Allie Fitter](https://github.com/alliefitter), author of original
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/)
- [jbpratt](https://github.com/jbpratt)
- [Chris Hollinworth](https://github.com/chrishollinworth)
- [Yoan Blanc](https://github.com/greut)
- [Kostya Leschenko](https://github.com/kleschenko)
- [pyto86](https://github.com/pyto86pri)
- [Ashton Honnecke](https://github.com/ahonnecke)
- [Mike Carey](https://github.com/mike-carey)
- [Ole-Martin Bratteng](https://github.com/omBratteng)
- [Nikhil Benesch](https://github.com/benesch)
- [Maksym Balatsko](https://github.com/mbalatsko)
- [Jacob](https://github.com/fivepapertigers)
- [Jakob Keller](https://github.com/jakob-keller)
- [Ari Pollak](https://github.com/aripollak)
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->
<!-- markdownlint-disable -->
<!-- markdownlint-restore -->
<!-- prettier-ignore-end -->
<!-- ALL-CONTRIBUTORS-LIST:END -->
Raw data
{
"_id": null,
"home_page": "https://youtype.github.io/mypy_boto3_builder/",
"name": "mypy-boto3-builder",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "boto3, type-annotations, pyright, mypy, boto3-stubs",
"author": "Vlad Emelianov",
"author_email": "vlad.emelianov.nz@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/60/ba/b3dcbc7a617518db81d16cd8aa9e585f7c5648183799cf0eeedde46137fa/mypy_boto3_builder-7.24.0.tar.gz",
"platform": null,
"description": "# Boto3 type annotations generator\n\n[](https://pypi.org/project/mypy-boto3-builder)\n[](https://pypi.org/project/boto3-stubs)\n[](https://youtype.github.io/mypy_boto3_builder/)\n\n[](https://pypi.org/project/boto3-stubs)\n[](https://pypi.org/project/boto3)\n[](https://youtype.github.io/boto3_stubs_docs/)\n[](https://pepy.tech/project/boto3-stubs)\n\n[](https://pypi.org/project/types-aiobotocore)\n[](https://pypi.org/project/aiobotocore)\n[](https://youtype.github.io/types_aiobotocore_docs/)\n[](https://pepy.tech/project/types-aiobotocore)\n\n[](https://pypi.org/project/types-aioboto3)\n[](https://pypi.org/project/aioboto3)\n[](https://youtype.github.io/types_aioboto3_docs/)\n[](https://pepy.tech/project/types-aioboto3)\n\n\n\nType annotations builder for [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\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\n\nDo you want more? Check the [documentation](https://youtype.github.io/boto3_stubs_docs/) and use `boto3` like a pro!\n\n- [Boto3 type annotations generator](#boto3-type-annotations-generator)\n - [Using built libraries](#using-built-libraries)\n - [boto3](#boto3)\n - [aiobotocore](#aiobotocore)\n - [aioboto3](#aioboto3)\n - [How to build type annotations](#how-to-build-type-annotations)\n - [Locally](#locally)\n - [With Docker image](#with-docker-image)\n - [Development](#development)\n - [Versioning](#versioning)\n - [Latest changes](#latest-changes)\n - [Thank you](#thank-you)\n - [Toolset](#toolset)\n - [Contributors](#contributors)\n\n## Using built libraries\n\n### boto3\n\nCheck [boto3-stubs](https://pypi.org/project/boto3-stubs/) project for installation\nand usage instructions.\n\nIf you use VSCode, add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\nIf not, just install `boto3-stubs` with `pip`:\n\n```bash\npython -m pip install 'boto3-stubs[essential]'\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'boto3-stubs-lite[essential]'\n\n# do not forget to install mypy or pyright\n```\n\nThat's it! You should already have code completion and type checking in your IDE.\n\n### aiobotocore\n\nCheck [types-aiobotocore](https://pypi.org/project/types-aiobotocore/) project for installation\nand usage instructions.\n\nOr just install `types-aiobotocore` with `pip`:\n\n```bash\npython -m pip install 'types-aiobotocore[essential]'\n\n# Lite version does not provide session.create_client overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-aiobotocore-lite[essential]'\n\n# do not forget to install mypy or pyright\n```\n\nReady to go! Enjoy code completion and type checking in your `aiobotocore` project.\n\n### aioboto3\n\nCheck [types-aioboto3](https://pypi.org/project/types-aioboto3/) project for installation\nand usage instructions.\n\nOr just install `types-aioboto3` with `pip`:\n\n```bash\npython -m pip install 'types-aioboto3[essential]'\n\n# Lite version does not provide session.client/resource overloads\n# it is more RAM-friendly, but requires explicit type annotations\npython -m pip install 'types-aioboto3-lite[essential]'\n\n# do not forget to install mypy or pyright\n```\n\nWhoa! All `aioboto3` methods and attributes are now type annotated and even code completion works.\n\n## How to build type annotations\n\n### Locally\n\n```bash\n# Install preferred version of `boto3`\npython -m pip install boto3==1.16.25 botocore==1.19.25\n\n# Install `mypy-boto3-builder`\npython -m pip install mypy-boto3-builder\n\n# Build all packages in mypy_boto3_output directory\npython -m mypy_boto3_builder mypy_boto3_output\n\n# Or specify required services explicitly\npython -m mypy_boto3_builder mypy_boto3_output -s ec2 s3\n\n# Install custom `boto3-stubs` packages\ncd mypy_boto3_output\npython -m pip install -e ./mypy_boto3_ec2_package\npython -m pip install -e ./mypy_boto3_s3_package\npython -m pip install -e ./boto3_stubs_package\n```\n\n### With Docker image\n\n- Install [Docker](https://docs.docker.com/install/)\n- Pull latest `mypy_boto3_builder` version and tag it\n\n```bash\ndocker pull docker.pkg.github.com/youtype/mypy_boto3_builder/mypy_boto3_builder_stable:latest\ndocker tag docker.pkg.github.com/youtype/mypy_boto3_builder/mypy_boto3_builder_stable:latest mypy_boto3_builder\n```\n\n- Generate stubs in `output` directory\n\n```bash\nmkdir output\n\n# generate stubs for all services\ndocker run -v `pwd`/output:/output -ti mypy_boto3_builder_stable\n\n# generate stubs for s3 service\ndocker run -v `pwd`/output:/output -ti mypy_boto3_builder_stable -s s3\n\n# generate stubs for a specific boto3 version\ndocker run -e BOTO3_VERSION=1.16.25 BOTOCORE_VERSION=1.19.25 -v `pwd`/output:/output -ti mypy_boto3_builder_stable\n```\n\n- Install packages from `output` directory as described above\n\n## Development\n\n- Install Python 3.11+, ideally with [pyenv](https://github.com/pyenv/pyenv)\n- Install [poetry](https://python-poetry.org/): `pip install poetry`\n- Install dependencies: `poetry install`\n- Use scripts for repo to check if everything works: `./scripts/build.sh`\n- Run manual pre-commit: `./scripts/before_commit.sh`\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\n## Thank you\n\n### Toolset\n\n- [black](https://github.com/psf/black) developers for an awesome formatting tool\n- [Timothy Edmund Crosley](https://github.com/timothycrosley) for\n [isort](https://github.com/PyCQA/isort) and how flexible it is\n- [mypy](https://github.com/python/mypy) developers for doing all dirty work for us\n- [pyright](https://github.com/microsoft/pyright) team for the new era of typed Python\n- [ruff](https://github.com/astral-sh/ruff) developers for the fastest swiss knife for Python\n\n### Contributors\n\n- [Allie Fitter](https://github.com/alliefitter), author of original\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/)\n- [jbpratt](https://github.com/jbpratt)\n- [Chris Hollinworth](https://github.com/chrishollinworth)\n- [Yoan Blanc](https://github.com/greut)\n- [Kostya Leschenko](https://github.com/kleschenko)\n- [pyto86](https://github.com/pyto86pri)\n- [Ashton Honnecke](https://github.com/ahonnecke)\n- [Mike Carey](https://github.com/mike-carey)\n- [Ole-Martin Bratteng](https://github.com/omBratteng)\n- [Nikhil Benesch](https://github.com/benesch)\n- [Maksym Balatsko](https://github.com/mbalatsko)\n- [Jacob](https://github.com/fivepapertigers)\n- [Jakob Keller](https://github.com/jakob-keller)\n- [Ari Pollak](https://github.com/aripollak)\n\n<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->\n<!-- prettier-ignore-start -->\n<!-- markdownlint-disable -->\n\n<!-- markdownlint-restore -->\n<!-- prettier-ignore-end -->\n\n<!-- ALL-CONTRIBUTORS-LIST:END -->\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Builder for boto3-stubs and types-aiobotocore",
"version": "7.24.0",
"project_urls": {
"Bug Tracker": "https://github.com/youtype/mypy_boto3_builder/issues",
"Documentation": "https://youtype.github.io/mypy_boto3_builder/",
"Homepage": "https://youtype.github.io/mypy_boto3_builder/",
"Repository": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder"
},
"split_keywords": [
"boto3",
" type-annotations",
" pyright",
" mypy",
" boto3-stubs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b659ac3b9ce13bfc85a9c4e3cfb75e9c31ab72050e2a19f2bddbca4626b9b5df",
"md5": "0c8be8e3e4b7b7adaedb4d5581ffd0c8",
"sha256": "4e5d16ce973222ce65316fee4581833f47320bbddfe3a12928874c1e52239aba"
},
"downloads": -1,
"filename": "mypy_boto3_builder-7.24.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0c8be8e3e4b7b7adaedb4d5581ffd0c8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 231729,
"upload_time": "2024-04-24T23:42:15",
"upload_time_iso_8601": "2024-04-24T23:42:15.348998Z",
"url": "https://files.pythonhosted.org/packages/b6/59/ac3b9ce13bfc85a9c4e3cfb75e9c31ab72050e2a19f2bddbca4626b9b5df/mypy_boto3_builder-7.24.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "60bab3dcbc7a617518db81d16cd8aa9e585f7c5648183799cf0eeedde46137fa",
"md5": "2e19fc9f7ea333ba84010012b59ae5ed",
"sha256": "caa91b8fa9aa081bef387ce79dd755689fe283e8696f7a0406bf7710dac9f8cc"
},
"downloads": -1,
"filename": "mypy_boto3_builder-7.24.0.tar.gz",
"has_sig": false,
"md5_digest": "2e19fc9f7ea333ba84010012b59ae5ed",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 119889,
"upload_time": "2024-04-24T23:42:18",
"upload_time_iso_8601": "2024-04-24T23:42:18.785947Z",
"url": "https://files.pythonhosted.org/packages/60/ba/b3dcbc7a617518db81d16cd8aa9e585f7c5648183799cf0eeedde46137fa/mypy_boto3_builder-7.24.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-24 23:42:18",
"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"
}
JSON
