diff --git a/builder/mypy_boto3_builder/templates/boto3-stubs/README.md.jinja2 b/builder/mypy_boto3_builder/templates/boto3-stubs/README.md.jinja2 index c8f99b95..443ac259 100644 --- a/builder/mypy_boto3_builder/templates/boto3-stubs/README.md.jinja2 +++ b/builder/mypy_boto3_builder/templates/boto3-stubs/README.md.jinja2 @@ -1,8 +1,13 @@ # boto3-stubs -Mypy-friendly type annotations for `boto3` {{ boto3_version }}. +Mypy-friendly type annotations for `boto3 {{ boto3_version }}`. More information can be found [here](https://github.com/vemel/mypy_boto3). +- [boto3-stubs](#boto3-stubs) + - [How to use](#how-to-use) + - [How it works](#how-it-works) + - [Submodules](#submodules) + ## How to use Make sure you have [mypy](https://github.com/python/mypy) installed ans activated in your IDE. @@ -27,6 +32,18 @@ import boto3 client = boto3.client("dynamo") ``` +## How it works + +Fully automated [builder](https://github.com/vemel/mypy_boto3) 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: + +- Latest version of `boto3` is used. +- Each public class and method of every `boto3` service gets valid type annotations + extracted from latest documentation (blame `botocore` docs if types are incorrect). +- Type annotations include up-to-date documentation. +- Code is processed by [black](https://github.com/psf/black) for readability. + ## Submodules - `all` - Type annotations for all `boto3` services. diff --git a/builder/mypy_boto3_builder/templates/master/README.md.jinja2 b/builder/mypy_boto3_builder/templates/master/README.md.jinja2 index 15e84733..684d2010 100644 --- a/builder/mypy_boto3_builder/templates/master/README.md.jinja2 +++ b/builder/mypy_boto3_builder/templates/master/README.md.jinja2 @@ -1,8 +1,15 @@ # mypy_boto3 -Mypy-friendly type annotations for `boto3` {{ boto3_version }}. +Mypy-friendly type annotations for `boto3 {{ boto3_version }}`. More information can be found [here](https://github.com/vemel/mypy_boto3). +- [mypy_boto3](#mypyboto3) + - [How to use](#how-to-use) + - [Type checking](#type-checking) + - [Code auto-complete](#code-auto-complete) + - [How it works](#how-it-works) + - [Submodules](#submodules) + ## How to use This package by itself is not very useful, it just gives you access to all @@ -44,6 +51,18 @@ client: Client = boto3.client("ec2") resource: ServiceResource = boto3.resource("ec2") ``` +## How it works + +Fully automated [builder](https://github.com/vemel/mypy_boto3) 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: + +- Latest version of `boto3` is used. +- Each public class and method of every `boto3` service gets valid type annotations + extracted from latest documentation (blame `botocore` docs if types are incorrect). +- Type annotations include up-to-date documentation. +- Code is processed by [black](https://github.com/psf/black) for readability. + ## Submodules - `all` - Type annotations for all `boto3` services. diff --git a/builder/mypy_boto3_builder/templates/service/README.md.jinja2 b/builder/mypy_boto3_builder/templates/service/README.md.jinja2 index 1ce71fe2..5308938e 100644 --- a/builder/mypy_boto3_builder/templates/service/README.md.jinja2 +++ b/builder/mypy_boto3_builder/templates/service/README.md.jinja2 @@ -1,8 +1,14 @@ # {{ service_name.pypi_name }} -Mypy-friendly auto-generated type annotations for `boto3` {{ boto3_version }} `{{ service_name.boto3_name }}` service. +Mypy-friendly auto-generated type annotations for `boto3 {{ service_name.boto3_name }} {{ boto3_version }}` service. More information can be found [here](https://github.com/vemel/mypy_boto3). +- [{{ service_name.pypi_name }}](#{{ service_name.pypi_name }}) + - [How to use](#how-to-use) + - [Type checking](#type-checking) + - [Code auto-complete](#code-auto-complete) + - [How it works](#how-it-works) + ## How to use ### Type checking @@ -75,3 +81,15 @@ resource: ServiceResource = boto3.resource("{{ service_name.boto3_name }}") {% endif -%} ``` {{ '\n' -}} + +## How it works + +Fully automated [builder](https://github.com/vemel/mypy_boto3) 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: + +- Latest version of `boto3` is used. +- Each public class and method of every `boto3` service gets valid type annotations + extracted from latest documentation (blame `botocore` docs if types are incorrect). +- Type annotations include up-to-date documentation. +- Code is processed by [black](https://github.com/psf/black) for readability.