# types-boto3
[](https://pypi.org/project/botocore-stubs)
[](https://pypi.org/project/botocore-stubs)
[](https://mypy-boto3-builder.readthedocs.io/)
[](https://pypistats.org/packages/botocore-stubs)
Proxy package for [boto3-stubs](https://pypi.org/project/boto3-stubs/).
Install submodules for `boto3` services type annotations.
Type annotations for
[botocore](https://github.com/boto/botocore)
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:
## How to install
### VSCode extension
Add [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)
extension to your VSCode and run `AWS boto3: Quick Start` command.
### From PyPI with pip
Install `botocore-stubs` to add type annotations for `botocore` package.
Install `boto3-stubs` to add type annotations for `boto3` package.
```bash
# install type annotations only for botocore
python -m pip install botocore-stubs
# install type annotations only for boto3 and botocore
python -m pip install botocore-stubs boto3-stubs
# install `boto3` type annotations
# for ec2, s3, rds, lambda, sqs, dynamo and cloudformation
# Consumes ~7 MB of space
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]'
# or install annotations for services you use
python -m pip install 'boto3-stubs[acm,apigateway]'
```
### From conda-forge
Installing `boto3-stubs` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:
```bash
conda config --add channels conda-forge
conda config --set channel_priority strict
```
Once the `conda-forge` channel has been enabled, `boto3-stubs` and `boto3-stubs-essential` can be installed with:
```bash
conda install boto3-stubs boto3-stubs-essential
```
It is possible to list all of the versions of `boto3-stubs` available on your platform with:
```bash
conda search boto3-stubs --channel conda-forge
```
## How to uninstall
```bash
# uninstall boto3-stubs
python -m pip uninstall -y boto3-stubs botocore-stubs
# uninstall submodules
python -m pip freeze | grep mypy-boto3 | xargs python -m pip uninstall -y
```
## Usage
### VSCode
- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)
- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)
- Set `Pylance` as your Python Language Server
- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`
Both type checking and code completion should work for installed `boto3` services.
No explicit type annotations required, write your `boto3` code as usual.
### PyCharm
- Install `boto3-stubs-lite` with services you use in your environment:
```bash
python -m pip install 'boto3-stubs-lite[s3,ec2]'
```
Both type checking and code completion should work for installed services.
Explicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery.
### Emacs
- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`
- Install
[use-package](https://github.com/jwiegley/use-package),
[lsp](https://github.com/emacs-lsp/lsp-mode/),
[company](https://github.com/company-mode/company-mode) and
[flycheck](https://github.com/flycheck/flycheck) packages
- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package
```elisp
(use-package lsp-pyright
:ensure t
:hook (python-mode . (lambda ()
(require 'lsp-pyright)
(lsp))) ; or lsp-deferred
:init (when (executable-find "python3")
(setq lsp-pyright-python-executable-cmd "python3"))
)
```
- Make sure emacs uses the environment where you have installed `boto3-stubs`
### Sublime Text
- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`
- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package
- Make sure emacs uses the environment where you have installed `boto3-stubs`
### Other IDEs
Not tested, but as long as your IDE supports `mypy` or `pyright`, everything should work.
### mypy
- Install `mypy`: `python -m pip install mypy`
- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`
- Run `mypy` as usual
Type checking should work for installed `boto3` services.
No explicit type annotations required, write your `boto3` code as usual.
### pyright
- Install `pyright`: `yarn global add pyright`
- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`
- Optionally, you can install `boto3-stubs` to `typings` folder.
Type checking should work for installed `boto3` services.
No explicit type annotations required, write your `boto3` code as usual.
## How it works
Fully automated [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully generates
type annotations for each service, patiently waiting for `boto3` updates. It delivers
a drop-in type annotations for you and makes sure that:
- All available `boto3` services are covered.
- Each public class and method of every `boto3` service gets valid type annotations
extracted from the documentation (blame `botocore` docs if types are incorrect).
- Type annotations include up-to-date documentation.
- Link to documentation is provided for every method.
- Code is processed by [black](https://github.com/psf/black)
and [isort](https://github.com/PyCQA/isort) for readability.
## What's new
### Implemented features
- Fully type annotated `boto3` library
- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility
- `Client` type annotations for each service
- `ServiceResource` type annotations for each service
- `Resource` type annotations for each service
- `Waiter` type annotations for each service
- `Paginator` type annotations for each service
- Generated `TypeDefs` for each service
- Generated `Literals` for each service
- Auto discovery of types for `boto3.client` and `boto3.session` calls
- Auto discovery of types for `session.client` and `session.session` calls
- Auto discovery of types for `client.get_waiter` and `client.get_paginator` calls
- Auto discovery of types for `ServiceResource` and `Resource` collections
### Latest changes
Builder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases).
## Versioning
`botocore-stubs` version is the same as related `botocore` version and follows
[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.
## Thank you
- [Allie Fitter](https://github.com/alliefitter) for
[boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),
this package is based on top of his work
- [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
## Documentation
All services type annotations can be found in [boto3-stubs docs](https://youtype.github.io/boto3_stubs_docs/)
## Support and contributing
This package is auto-generated. Please reports any bugs or request new features in
[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) repository.
Raw data
{
"_id": null,
"home_page": "https://github.com/youtype/mypy_boto3_builder",
"name": "types-boto3",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"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/49/0a/0d160bd310f86bfcf47eedfdc31b6078428c1e964981ec107ef38a1a3e06/types-boto3-1.0.2.tar.gz",
"platform": "any",
"description": "# types-boto3\n\n[](https://pypi.org/project/botocore-stubs)\n[](https://pypi.org/project/botocore-stubs)\n[](https://mypy-boto3-builder.readthedocs.io/)\n[](https://pypistats.org/packages/botocore-stubs)\n\n\n\nProxy package for [boto3-stubs](https://pypi.org/project/boto3-stubs/).\nInstall submodules for `boto3` services type annotations.\n\nType annotations for\n[botocore](https://github.com/boto/botocore)\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\n\n## How to install\n\n### VSCode extension\n\nAdd [AWS Boto3](https://marketplace.visualstudio.com/items?itemName=Boto3typed.boto3-ide)\nextension to your VSCode and run `AWS boto3: Quick Start` command.\n\n### From PyPI with pip\n\nInstall `botocore-stubs` to add type annotations for `botocore` package.\nInstall `boto3-stubs` to add type annotations for `boto3` package.\n\n```bash\n# install type annotations only for botocore\npython -m pip install botocore-stubs\n\n# install type annotations only for boto3 and botocore\npython -m pip install botocore-stubs boto3-stubs\n\n# install `boto3` type annotations\n# for ec2, s3, rds, lambda, sqs, dynamo and cloudformation\n# Consumes ~7 MB of space\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# or install annotations for services you use\npython -m pip install 'boto3-stubs[acm,apigateway]'\n```\n\n### From conda-forge\n\nInstalling `boto3-stubs` from the `conda-forge` channel can be achieved by adding `conda-forge` to your channels with:\n\n```bash\nconda config --add channels conda-forge\nconda config --set channel_priority strict\n```\n\nOnce the `conda-forge` channel has been enabled, `boto3-stubs` and `boto3-stubs-essential` can be installed with:\n\n```bash\nconda install boto3-stubs boto3-stubs-essential\n```\n\nIt is possible to list all of the versions of `boto3-stubs` available on your platform with:\n\n```bash\nconda search boto3-stubs --channel conda-forge\n```\n\n## How to uninstall\n\n```bash\n# uninstall boto3-stubs\npython -m pip uninstall -y boto3-stubs botocore-stubs\n\n# uninstall submodules\npython -m pip freeze | grep mypy-boto3 | xargs python -m pip uninstall -y\n```\n\n## Usage\n\n### VSCode\n\n- Install [Python extension](https://marketplace.visualstudio.com/items?itemName=ms-python.python)\n- Install [Pylance extension](https://marketplace.visualstudio.com/items?itemName=ms-python.vscode-pylance)\n- Set `Pylance` as your Python Language Server\n- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`\n\nBoth type checking and code completion should work for installed `boto3` services.\nNo explicit type annotations required, write your `boto3` code as usual.\n\n### PyCharm\n\n- Install `boto3-stubs-lite` with services you use in your environment:\n\n```bash\npython -m pip install 'boto3-stubs-lite[s3,ec2]'\n```\n\nBoth type checking and code completion should work for installed services.\nExplicit type annotations **are required**. Use `boto3-stubs` package instead for implicit type discovery.\n\n### Emacs\n\n- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`\n- Install\n [use-package](https://github.com/jwiegley/use-package),\n [lsp](https://github.com/emacs-lsp/lsp-mode/),\n [company](https://github.com/company-mode/company-mode) and\n [flycheck](https://github.com/flycheck/flycheck) packages\n- Install [lsp-pyright](https://github.com/emacs-lsp/lsp-pyright) package\n\n```elisp\n(use-package lsp-pyright\n :ensure t\n :hook (python-mode . (lambda ()\n (require 'lsp-pyright)\n (lsp))) ; or lsp-deferred\n :init (when (executable-find \"python3\")\n (setq lsp-pyright-python-executable-cmd \"python3\"))\n )\n```\n\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\n### Sublime Text\n\n- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`\n- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package\n- Make sure emacs uses the environment where you have installed `boto3-stubs`\n\n### Other IDEs\n\nNot tested, but as long as your IDE supports `mypy` or `pyright`, everything should work.\n\n### mypy\n\n- Install `mypy`: `python -m pip install mypy`\n- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`\n- Run `mypy` as usual\n\nType checking should work for installed `boto3` services.\nNo explicit type annotations required, write your `boto3` code as usual.\n\n### pyright\n\n- Install `pyright`: `yarn global add pyright`\n- Install `boto3-stubs` with services you use in your environment: `python -m pip install 'boto3-stubs[s3,ec2]'`\n- Optionally, you can install `boto3-stubs` to `typings` folder.\n\nType checking should work for installed `boto3` services.\nNo explicit type annotations required, write your `boto3` code as usual.\n\n## How it works\n\nFully automated [mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder) carefully generates\ntype annotations for each service, patiently waiting for `boto3` updates. It delivers\na drop-in type annotations for you and makes sure that:\n\n- All available `boto3` services are covered.\n- Each public class and method of every `boto3` service gets valid type annotations\n extracted from the documentation (blame `botocore` docs if types are incorrect).\n- Type annotations include up-to-date documentation.\n- Link to documentation is provided for every method.\n- Code is processed by [black](https://github.com/psf/black)\n and [isort](https://github.com/PyCQA/isort) for readability.\n\n## What's new\n\n### Implemented features\n\n- Fully type annotated `boto3` library\n- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` compatibility\n- `Client` type annotations for each service\n- `ServiceResource` type annotations for each service\n- `Resource` type annotations for each service\n- `Waiter` type annotations for each service\n- `Paginator` type annotations for each service\n- Generated `TypeDefs` for each service\n- Generated `Literals` for each service\n- Auto discovery of types for `boto3.client` and `boto3.session` calls\n- Auto discovery of types for `session.client` and `session.session` calls\n- Auto discovery of types for `client.get_waiter` and `client.get_paginator` calls\n- Auto discovery of types for `ServiceResource` and `Resource` collections\n\n### Latest changes\n\nBuilder changelog can be found in [Releases](https://github.com/youtype/mypy_boto3_builder/releases).\n\n## Versioning\n\n`botocore-stubs` version is the same as related `botocore` version and follows\n[PEP 440](https://www.python.org/dev/peps/pep-0440/) format.\n\n## Thank you\n\n- [Allie Fitter](https://github.com/alliefitter) for\n [boto3-type-annotations](https://pypi.org/project/boto3-type-annotations/),\n this package is based on top of his work\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\n## Documentation\n\nAll services type annotations can be found in [boto3-stubs docs](https://youtype.github.io/boto3_stubs_docs/)\n\n## Support and contributing\n\nThis package is auto-generated. Please reports any bugs or request new features in\n[mypy-boto3-builder](https://github.com/youtype/mypy_boto3_builder/issues/) repository.\n\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Proxy package for boto3-stubs",
"version": "1.0.2",
"project_urls": {
"Documentation": "https://mypy-boto3-builder.readthedocs.io/en/latest/",
"Homepage": "https://github.com/youtype/mypy_boto3_builder",
"Source": "https://github.com/youtype/mypy_boto3_builder",
"Tracker": "https://github.com/youtype/mypy_boto3_builder/issues"
},
"split_keywords": [
"boto3",
"type-annotations",
"pyright",
"mypy",
"boto3-stubs"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "be8c02cfe4a1684d7bb645135238436f56fed4604a7595f1c74e8156cd6e5bec",
"md5": "8956ba6ec92499a301ba3d587a423f1f",
"sha256": "a6a88e94d59d887839863a64095493956efc148e747206880a7eb47d90ae8398"
},
"downloads": -1,
"filename": "types_boto3-1.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "8956ba6ec92499a301ba3d587a423f1f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 5090,
"upload_time": "2022-04-01T13:48:50",
"upload_time_iso_8601": "2022-04-01T13:48:50.950682Z",
"url": "https://files.pythonhosted.org/packages/be/8c/02cfe4a1684d7bb645135238436f56fed4604a7595f1c74e8156cd6e5bec/types_boto3-1.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "490a0d160bd310f86bfcf47eedfdc31b6078428c1e964981ec107ef38a1a3e06",
"md5": "579ca849cd6458213696f6bdcc2fb45c",
"sha256": "15f3ffad0314e40a0708fec25f94891414f93260202422bf8b19b6913853c983"
},
"downloads": -1,
"filename": "types-boto3-1.0.2.tar.gz",
"has_sig": false,
"md5_digest": "579ca849cd6458213696f6bdcc2fb45c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 5039,
"upload_time": "2022-04-01T13:48:52",
"upload_time_iso_8601": "2022-04-01T13:48:52.280194Z",
"url": "https://files.pythonhosted.org/packages/49/0a/0d160bd310f86bfcf47eedfdc31b6078428c1e964981ec107ef38a1a3e06/types-boto3-1.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-04-01 13:48:52",
"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": "types-boto3"
}
JSON
