From 791196367e637746f82c4b56acb7610fc91f1511 Mon Sep 17 00:00:00 2001 From: CoprDistGit Date: Tue, 11 Apr 2023 12:19:01 +0000 Subject: automatic import of python-mypy-boto3-ivs --- python-mypy-boto3-ivs.spec | 1522 ++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 1522 insertions(+) create mode 100644 python-mypy-boto3-ivs.spec (limited to 'python-mypy-boto3-ivs.spec') diff --git a/python-mypy-boto3-ivs.spec b/python-mypy-boto3-ivs.spec new file mode 100644 index 0000000..69790a0 --- /dev/null +++ b/python-mypy-boto3-ivs.spec @@ -0,0 +1,1522 @@ +%global _empty_manifest_terminate_build 0 +Name: python-mypy-boto3-ivs +Version: 1.26.103 +Release: 1 +Summary: Type annotations for boto3.IVS 1.26.103 service generated with mypy-boto3-builder 7.14.4 +License: MIT License +URL: https://github.com/youtype/mypy_boto3_builder +Source0: https://mirrors.nju.edu.cn/pypi/web/packages/77/14/a2617af20b965a8e68b6264531a3e41262e321a88310582ec982429d1fc5/mypy-boto3-ivs-1.26.103.tar.gz +BuildArch: noarch + +Requires: python3-typing-extensions + +%description + + +# mypy-boto3-ivs + +[![PyPI - mypy-boto3-ivs](https://img.shields.io/pypi/v/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-ivs?color=blue)](https://pypistats.org/packages/mypy-boto3-ivs) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.IVS 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS) +service 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. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-ivs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/). + +See how it helps to find and fix potential bugs: + +![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) + +- [mypy-boto3-ivs](#mypy-boto3-ivs) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + + + +## 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. + +Click `Modify` and select `boto3 common` and `IVS`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `IVS` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[ivs]' + + +# 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[ivs]' + + +# standalone installation +python -m pip install mypy-boto3-ivs +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-ivs +``` + + + +## 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[ivs]'` +``` + +Both type checking and code completion should now work. 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: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- 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` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### Sublime Text + +- Install `boto3-stubs[ivs]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +## Explicit type annotations + + + +### Client annotations + +`IVSClient` provides annotations for `boto3.client("ivs")`. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient + +client: IVSClient = Session().client("ivs") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_ivs.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient +from mypy_boto3_ivs.paginator import ( + ListChannelsPaginator, + ListPlaybackKeyPairsPaginator, + ListRecordingConfigurationsPaginator, + ListStreamKeysPaginator, + ListStreamsPaginator, +) + +client: IVSClient = Session().client("ivs") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels") +list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator( + "list_playback_key_pairs" +) +list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = ( + client.get_paginator("list_recording_configurations") +) +list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys") +list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams") +``` + + + +### Literals + +`mypy_boto3_ivs.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_ivs.literals import ( + ChannelLatencyModeType, + ChannelTypeType, + ListChannelsPaginatorName, + ListPlaybackKeyPairsPaginatorName, + ListRecordingConfigurationsPaginatorName, + ListStreamKeysPaginatorName, + ListStreamsPaginatorName, + RecordingConfigurationStateType, + RecordingModeType, + StreamHealthType, + StreamStateType, + IVSServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ChannelLatencyModeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_ivs.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_ivs.type_defs import ( + AudioConfigurationTypeDef, + BatchErrorTypeDef, + BatchGetChannelRequestRequestTypeDef, + ChannelTypeDef, + ResponseMetadataTypeDef, + BatchGetStreamKeyRequestRequestTypeDef, + StreamKeyTypeDef, + ChannelSummaryTypeDef, + CreateChannelRequestRequestTypeDef, + ThumbnailConfigurationTypeDef, + CreateStreamKeyRequestRequestTypeDef, + DeleteChannelRequestRequestTypeDef, + DeletePlaybackKeyPairRequestRequestTypeDef, + DeleteRecordingConfigurationRequestRequestTypeDef, + DeleteStreamKeyRequestRequestTypeDef, + S3DestinationConfigurationTypeDef, + GetChannelRequestRequestTypeDef, + GetPlaybackKeyPairRequestRequestTypeDef, + PlaybackKeyPairTypeDef, + GetRecordingConfigurationRequestRequestTypeDef, + GetStreamKeyRequestRequestTypeDef, + GetStreamRequestRequestTypeDef, + StreamTypeDef, + GetStreamSessionRequestRequestTypeDef, + ImportPlaybackKeyPairRequestRequestTypeDef, + VideoConfigurationTypeDef, + PaginatorConfigTypeDef, + ListChannelsRequestRequestTypeDef, + ListPlaybackKeyPairsRequestRequestTypeDef, + PlaybackKeyPairSummaryTypeDef, + ListRecordingConfigurationsRequestRequestTypeDef, + ListStreamKeysRequestRequestTypeDef, + StreamKeySummaryTypeDef, + ListStreamSessionsRequestRequestTypeDef, + StreamSessionSummaryTypeDef, + StreamFiltersTypeDef, + StreamSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + PutMetadataRequestRequestTypeDef, + StopStreamRequestRequestTypeDef, + StreamEventTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateChannelRequestRequestTypeDef, + BatchGetChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetChannelResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateChannelResponseTypeDef, + BatchGetStreamKeyResponseTypeDef, + CreateChannelResponseTypeDef, + CreateStreamKeyResponseTypeDef, + GetStreamKeyResponseTypeDef, + ListChannelsResponseTypeDef, + DestinationConfigurationTypeDef, + GetPlaybackKeyPairResponseTypeDef, + ImportPlaybackKeyPairResponseTypeDef, + GetStreamResponseTypeDef, + IngestConfigurationTypeDef, + ListChannelsRequestListChannelsPaginateTypeDef, + ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef, + ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef, + ListStreamKeysRequestListStreamKeysPaginateTypeDef, + ListPlaybackKeyPairsResponseTypeDef, + ListStreamKeysResponseTypeDef, + ListStreamSessionsResponseTypeDef, + ListStreamsRequestListStreamsPaginateTypeDef, + ListStreamsRequestRequestTypeDef, + ListStreamsResponseTypeDef, + CreateRecordingConfigurationRequestRequestTypeDef, + RecordingConfigurationSummaryTypeDef, + RecordingConfigurationTypeDef, + ListRecordingConfigurationsResponseTypeDef, + CreateRecordingConfigurationResponseTypeDef, + GetRecordingConfigurationResponseTypeDef, + StreamSessionTypeDef, + GetStreamSessionResponseTypeDef, +) + + +def get_structure() -> AudioConfigurationTypeDef: + return {...} +``` + + + +## 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 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 `botocore` schemas. +- 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`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-ivs` version is the same as related `boto3` 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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) + + + +## 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. + + +%package -n python3-mypy-boto3-ivs +Summary: Type annotations for boto3.IVS 1.26.103 service generated with mypy-boto3-builder 7.14.4 +Provides: python-mypy-boto3-ivs +BuildRequires: python3-devel +BuildRequires: python3-setuptools +BuildRequires: python3-pip +%description -n python3-mypy-boto3-ivs + + +# mypy-boto3-ivs + +[![PyPI - mypy-boto3-ivs](https://img.shields.io/pypi/v/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-ivs?color=blue)](https://pypistats.org/packages/mypy-boto3-ivs) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.IVS 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS) +service 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. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-ivs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/). + +See how it helps to find and fix potential bugs: + +![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) + +- [mypy-boto3-ivs](#mypy-boto3-ivs) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + + + +## 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. + +Click `Modify` and select `boto3 common` and `IVS`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `IVS` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[ivs]' + + +# 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[ivs]' + + +# standalone installation +python -m pip install mypy-boto3-ivs +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-ivs +``` + + + +## 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[ivs]'` +``` + +Both type checking and code completion should now work. 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: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- 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` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### Sublime Text + +- Install `boto3-stubs[ivs]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +## Explicit type annotations + + + +### Client annotations + +`IVSClient` provides annotations for `boto3.client("ivs")`. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient + +client: IVSClient = Session().client("ivs") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_ivs.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient +from mypy_boto3_ivs.paginator import ( + ListChannelsPaginator, + ListPlaybackKeyPairsPaginator, + ListRecordingConfigurationsPaginator, + ListStreamKeysPaginator, + ListStreamsPaginator, +) + +client: IVSClient = Session().client("ivs") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels") +list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator( + "list_playback_key_pairs" +) +list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = ( + client.get_paginator("list_recording_configurations") +) +list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys") +list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams") +``` + + + +### Literals + +`mypy_boto3_ivs.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_ivs.literals import ( + ChannelLatencyModeType, + ChannelTypeType, + ListChannelsPaginatorName, + ListPlaybackKeyPairsPaginatorName, + ListRecordingConfigurationsPaginatorName, + ListStreamKeysPaginatorName, + ListStreamsPaginatorName, + RecordingConfigurationStateType, + RecordingModeType, + StreamHealthType, + StreamStateType, + IVSServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ChannelLatencyModeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_ivs.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_ivs.type_defs import ( + AudioConfigurationTypeDef, + BatchErrorTypeDef, + BatchGetChannelRequestRequestTypeDef, + ChannelTypeDef, + ResponseMetadataTypeDef, + BatchGetStreamKeyRequestRequestTypeDef, + StreamKeyTypeDef, + ChannelSummaryTypeDef, + CreateChannelRequestRequestTypeDef, + ThumbnailConfigurationTypeDef, + CreateStreamKeyRequestRequestTypeDef, + DeleteChannelRequestRequestTypeDef, + DeletePlaybackKeyPairRequestRequestTypeDef, + DeleteRecordingConfigurationRequestRequestTypeDef, + DeleteStreamKeyRequestRequestTypeDef, + S3DestinationConfigurationTypeDef, + GetChannelRequestRequestTypeDef, + GetPlaybackKeyPairRequestRequestTypeDef, + PlaybackKeyPairTypeDef, + GetRecordingConfigurationRequestRequestTypeDef, + GetStreamKeyRequestRequestTypeDef, + GetStreamRequestRequestTypeDef, + StreamTypeDef, + GetStreamSessionRequestRequestTypeDef, + ImportPlaybackKeyPairRequestRequestTypeDef, + VideoConfigurationTypeDef, + PaginatorConfigTypeDef, + ListChannelsRequestRequestTypeDef, + ListPlaybackKeyPairsRequestRequestTypeDef, + PlaybackKeyPairSummaryTypeDef, + ListRecordingConfigurationsRequestRequestTypeDef, + ListStreamKeysRequestRequestTypeDef, + StreamKeySummaryTypeDef, + ListStreamSessionsRequestRequestTypeDef, + StreamSessionSummaryTypeDef, + StreamFiltersTypeDef, + StreamSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + PutMetadataRequestRequestTypeDef, + StopStreamRequestRequestTypeDef, + StreamEventTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateChannelRequestRequestTypeDef, + BatchGetChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetChannelResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateChannelResponseTypeDef, + BatchGetStreamKeyResponseTypeDef, + CreateChannelResponseTypeDef, + CreateStreamKeyResponseTypeDef, + GetStreamKeyResponseTypeDef, + ListChannelsResponseTypeDef, + DestinationConfigurationTypeDef, + GetPlaybackKeyPairResponseTypeDef, + ImportPlaybackKeyPairResponseTypeDef, + GetStreamResponseTypeDef, + IngestConfigurationTypeDef, + ListChannelsRequestListChannelsPaginateTypeDef, + ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef, + ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef, + ListStreamKeysRequestListStreamKeysPaginateTypeDef, + ListPlaybackKeyPairsResponseTypeDef, + ListStreamKeysResponseTypeDef, + ListStreamSessionsResponseTypeDef, + ListStreamsRequestListStreamsPaginateTypeDef, + ListStreamsRequestRequestTypeDef, + ListStreamsResponseTypeDef, + CreateRecordingConfigurationRequestRequestTypeDef, + RecordingConfigurationSummaryTypeDef, + RecordingConfigurationTypeDef, + ListRecordingConfigurationsResponseTypeDef, + CreateRecordingConfigurationResponseTypeDef, + GetRecordingConfigurationResponseTypeDef, + StreamSessionTypeDef, + GetStreamSessionResponseTypeDef, +) + + +def get_structure() -> AudioConfigurationTypeDef: + return {...} +``` + + + +## 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 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 `botocore` schemas. +- 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`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-ivs` version is the same as related `boto3` 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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) + + + +## 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. + + +%package help +Summary: Development documents and examples for mypy-boto3-ivs +Provides: python3-mypy-boto3-ivs-doc +%description help + + +# mypy-boto3-ivs + +[![PyPI - mypy-boto3-ivs](https://img.shields.io/pypi/v/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/mypy-boto3-ivs.svg?color=blue)](https://pypi.org/project/mypy-boto3-ivs) +[![Docs](https://img.shields.io/readthedocs/boto3-stubs.svg?color=blue)](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) +[![PyPI - Downloads](https://img.shields.io/pypi/dm/mypy-boto3-ivs?color=blue)](https://pypistats.org/packages/mypy-boto3-ivs) + +![boto3.typed](https://github.com/youtype/mypy_boto3_builder/raw/main/logo.png) + +Type annotations for +[boto3.IVS 1.26.103](https://boto3.amazonaws.com/v1/documentation/api/latest/reference/services/ivs.html#IVS) +service 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. + +Generated by +[mypy-boto3-builder 7.14.4](https://github.com/youtype/mypy_boto3_builder). + +More information can be found on +[boto3-stubs](https://pypi.org/project/boto3-stubs/) page and in +[mypy-boto3-ivs docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/). + +See how it helps to find and fix potential bugs: + +![boto3-stubs demo](https://github.com/youtype/mypy_boto3_builder/raw/main/demo.gif) + +- [mypy-boto3-ivs](#mypy-boto3-ivs) + - [How to install](#how-to-install) + - [VSCode extension](#vscode-extension) + - [From PyPI with pip](#from-pypi-with-pip) + - [How to uninstall](#how-to-uninstall) + - [Usage](#usage) + - [VSCode](#vscode) + - [PyCharm](#pycharm) + - [Emacs](#emacs) + - [Sublime Text](#sublime-text) + - [Other IDEs](#other-ides) + - [mypy](#mypy) + - [pyright](#pyright) + - [Explicit type annotations](#explicit-type-annotations) + - [Client annotations](#client-annotations) + - [Paginators annotations](#paginators-annotations) + - [Literals](#literals) + - [Typed dictionaries](#typed-dictionaries) + - [How it works](#how-it-works) + - [What's new](#what's-new) + - [Implemented features](#implemented-features) + - [Latest changes](#latest-changes) + - [Versioning](#versioning) + - [Thank you](#thank-you) + - [Documentation](#documentation) + - [Support and contributing](#support-and-contributing) + + + +## 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. + +Click `Modify` and select `boto3 common` and `IVS`. + + + +### From PyPI with pip + +Install `boto3-stubs` for `IVS` service. + +```bash +# install with boto3 type annotations +python -m pip install 'boto3-stubs[ivs]' + + +# 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[ivs]' + + +# standalone installation +python -m pip install mypy-boto3-ivs +``` + + + +## How to uninstall + +```bash +python -m pip uninstall -y mypy-boto3-ivs +``` + + + +## 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Both type checking and code completion should now work. No explicit type +annotations required, write your `boto3` code as usual. + + + +### PyCharm + +Install `boto3-stubs-lite[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs-lite[ivs]'` +``` + +Both type checking and code completion should now work. 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: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- 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` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### Sublime Text + +- Install `boto3-stubs[ivs]` with services you use in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +- Install [LSP-pyright](https://github.com/sublimelsp/LSP-pyright) package + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### 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[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]'` +``` + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +### pyright + +- Install `pyright`: `npm i -g pyright` +- Install `boto3-stubs[ivs]` in your environment: + +```bash +python -m pip install 'boto3-stubs[ivs]' +``` + +Optionally, you can install `boto3-stubs` to `typings` folder. + +Type checking should now work. No explicit type annotations required, write +your `boto3` code as usual. + + + +## Explicit type annotations + + + +### Client annotations + +`IVSClient` provides annotations for `boto3.client("ivs")`. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient + +client: IVSClient = Session().client("ivs") + +# now client usage is checked by mypy and IDE should provide code completion +``` + + + +### Paginators annotations + +`mypy_boto3_ivs.paginator` module contains type annotations for all paginators. + +```python +from boto3.session import Session + +from mypy_boto3_ivs import IVSClient +from mypy_boto3_ivs.paginator import ( + ListChannelsPaginator, + ListPlaybackKeyPairsPaginator, + ListRecordingConfigurationsPaginator, + ListStreamKeysPaginator, + ListStreamsPaginator, +) + +client: IVSClient = Session().client("ivs") + +# Explicit type annotations are optional here +# Types should be correctly discovered by mypy and IDEs +list_channels_paginator: ListChannelsPaginator = client.get_paginator("list_channels") +list_playback_key_pairs_paginator: ListPlaybackKeyPairsPaginator = client.get_paginator( + "list_playback_key_pairs" +) +list_recording_configurations_paginator: ListRecordingConfigurationsPaginator = ( + client.get_paginator("list_recording_configurations") +) +list_stream_keys_paginator: ListStreamKeysPaginator = client.get_paginator("list_stream_keys") +list_streams_paginator: ListStreamsPaginator = client.get_paginator("list_streams") +``` + + + +### Literals + +`mypy_boto3_ivs.literals` module contains literals extracted from shapes that +can be used in user code for type checking. + +```python +from mypy_boto3_ivs.literals import ( + ChannelLatencyModeType, + ChannelTypeType, + ListChannelsPaginatorName, + ListPlaybackKeyPairsPaginatorName, + ListRecordingConfigurationsPaginatorName, + ListStreamKeysPaginatorName, + ListStreamsPaginatorName, + RecordingConfigurationStateType, + RecordingModeType, + StreamHealthType, + StreamStateType, + IVSServiceName, + ServiceName, + ResourceServiceName, + PaginatorName, + RegionName, +) + + +def check_value(value: ChannelLatencyModeType) -> bool: + ... +``` + + + +### Typed dictionaries + +`mypy_boto3_ivs.type_defs` module contains structures and shapes assembled to +typed dictionaries for additional type checking. + +```python +from mypy_boto3_ivs.type_defs import ( + AudioConfigurationTypeDef, + BatchErrorTypeDef, + BatchGetChannelRequestRequestTypeDef, + ChannelTypeDef, + ResponseMetadataTypeDef, + BatchGetStreamKeyRequestRequestTypeDef, + StreamKeyTypeDef, + ChannelSummaryTypeDef, + CreateChannelRequestRequestTypeDef, + ThumbnailConfigurationTypeDef, + CreateStreamKeyRequestRequestTypeDef, + DeleteChannelRequestRequestTypeDef, + DeletePlaybackKeyPairRequestRequestTypeDef, + DeleteRecordingConfigurationRequestRequestTypeDef, + DeleteStreamKeyRequestRequestTypeDef, + S3DestinationConfigurationTypeDef, + GetChannelRequestRequestTypeDef, + GetPlaybackKeyPairRequestRequestTypeDef, + PlaybackKeyPairTypeDef, + GetRecordingConfigurationRequestRequestTypeDef, + GetStreamKeyRequestRequestTypeDef, + GetStreamRequestRequestTypeDef, + StreamTypeDef, + GetStreamSessionRequestRequestTypeDef, + ImportPlaybackKeyPairRequestRequestTypeDef, + VideoConfigurationTypeDef, + PaginatorConfigTypeDef, + ListChannelsRequestRequestTypeDef, + ListPlaybackKeyPairsRequestRequestTypeDef, + PlaybackKeyPairSummaryTypeDef, + ListRecordingConfigurationsRequestRequestTypeDef, + ListStreamKeysRequestRequestTypeDef, + StreamKeySummaryTypeDef, + ListStreamSessionsRequestRequestTypeDef, + StreamSessionSummaryTypeDef, + StreamFiltersTypeDef, + StreamSummaryTypeDef, + ListTagsForResourceRequestRequestTypeDef, + PutMetadataRequestRequestTypeDef, + StopStreamRequestRequestTypeDef, + StreamEventTypeDef, + TagResourceRequestRequestTypeDef, + UntagResourceRequestRequestTypeDef, + UpdateChannelRequestRequestTypeDef, + BatchGetChannelResponseTypeDef, + EmptyResponseMetadataTypeDef, + GetChannelResponseTypeDef, + ListTagsForResourceResponseTypeDef, + UpdateChannelResponseTypeDef, + BatchGetStreamKeyResponseTypeDef, + CreateChannelResponseTypeDef, + CreateStreamKeyResponseTypeDef, + GetStreamKeyResponseTypeDef, + ListChannelsResponseTypeDef, + DestinationConfigurationTypeDef, + GetPlaybackKeyPairResponseTypeDef, + ImportPlaybackKeyPairResponseTypeDef, + GetStreamResponseTypeDef, + IngestConfigurationTypeDef, + ListChannelsRequestListChannelsPaginateTypeDef, + ListPlaybackKeyPairsRequestListPlaybackKeyPairsPaginateTypeDef, + ListRecordingConfigurationsRequestListRecordingConfigurationsPaginateTypeDef, + ListStreamKeysRequestListStreamKeysPaginateTypeDef, + ListPlaybackKeyPairsResponseTypeDef, + ListStreamKeysResponseTypeDef, + ListStreamSessionsResponseTypeDef, + ListStreamsRequestListStreamsPaginateTypeDef, + ListStreamsRequestRequestTypeDef, + ListStreamsResponseTypeDef, + CreateRecordingConfigurationRequestRequestTypeDef, + RecordingConfigurationSummaryTypeDef, + RecordingConfigurationTypeDef, + ListRecordingConfigurationsResponseTypeDef, + CreateRecordingConfigurationResponseTypeDef, + GetRecordingConfigurationResponseTypeDef, + StreamSessionTypeDef, + GetStreamSessionResponseTypeDef, +) + + +def get_structure() -> AudioConfigurationTypeDef: + return {...} +``` + + + +## 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 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 `botocore` schemas. +- 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`, `botocore`, `aiobotocore` and `aioboto3` + libraries +- `mypy`, `pyright`, `VSCode`, `PyCharm`, `Sublime Text` and `Emacs` + compatibility +- `Client`, `ServiceResource`, `Resource`, `Waiter` `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.resource` calls +- Auto discovery of types for `session.client` and `session.resource` calls +- Auto discovery of types for `client.get_waiter` and `client.get_paginator` + calls +- Auto discovery of types for `ServiceResource` and `Resource` collections +- Auto discovery of types for `aiobotocore.Session.create_client` calls + + + +### Latest changes + +Builder changelog can be found in +[Releases](https://github.com/youtype/mypy_boto3_builder/releases). + + + +## Versioning + +`mypy-boto3-ivs` version is the same as related `boto3` 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 docs](https://youtype.github.io/boto3_stubs_docs/mypy_boto3_ivs/) + + + +## 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. + + +%prep +%autosetup -n mypy-boto3-ivs-1.26.103 + +%build +%py3_build + +%install +%py3_install +install -d -m755 %{buildroot}/%{_pkgdocdir} +if [ -d doc ]; then cp -arf doc %{buildroot}/%{_pkgdocdir}; fi +if [ -d docs ]; then cp -arf docs %{buildroot}/%{_pkgdocdir}; fi +if [ -d example ]; then cp -arf example %{buildroot}/%{_pkgdocdir}; fi +if [ -d examples ]; then cp -arf examples %{buildroot}/%{_pkgdocdir}; fi +pushd %{buildroot} +if [ -d usr/lib ]; then + find usr/lib -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/lib64 ]; then + find usr/lib64 -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/bin ]; then + find usr/bin -type f -printf "/%h/%f\n" >> filelist.lst +fi +if [ -d usr/sbin ]; then + find usr/sbin -type f -printf "/%h/%f\n" >> filelist.lst +fi +touch doclist.lst +if [ -d usr/share/man ]; then + find usr/share/man -type f -printf "/%h/%f.gz\n" >> doclist.lst +fi +popd +mv %{buildroot}/filelist.lst . +mv %{buildroot}/doclist.lst . + +%files -n python3-mypy-boto3-ivs -f filelist.lst +%dir %{python3_sitelib}/* + +%files help -f doclist.lst +%{_docdir}/* + +%changelog +* Tue Apr 11 2023 Python_Bot - 1.26.103-1 +- Package Spec generated -- cgit v1.2.3