Skip to main content

PyPI version

Downloads Downloads Downloads

Build badge

botostubs

Gives you code assistance for any boto3 API in any IDE. Get started by running pip install botostubs

Demo

See demo gif on github

Features

  • PyPI package automatically aligned with boto3 (yay!)
  • show required / optional fields
  • show API docs as Python docstrings
  • full api coverage
  • support for boto3 clients, e.g type: botostubs.ACM
  • support for service-level resources, e.g type: botostubs.S3.S3Resource
  • support for paginators, e.g type: botostubs.EC2.DescribeInstancesPaginator
  • support for waiters, e.g type: botostubs.EC2.InstanceRunningWaiter

How it works

We look for all boto3 clients by running boto itself. Then loop over each of them to find what operations and classes are used. These are all dumped in a new python script, packaged in this project. This way, botostubs can offer comprehensive API coverage.

The deployment pipeline on AWS checks for boto3 releases every 3 days, installs it, generate new stubs and pushes them to PyPI. Looking for a new API released a few days ago? Just upgrade the package with pip install --upgrade botostubs and you're good to go.

For an in-depth account, see the blog post Code assistance for boto3, always up to date and in any IDE

Notes

  • This package requires that your IDE already supports getting type hints from PyPI packages. It has been tested with Intellij and Visual Studio Code.
  • If you are not seeing code completion in Intellij-based ones, please increase the intellisense filesize limit e.g idea.max.intellisense.filesize=20000 in IDE custom properties (Help > Edit Custom Properties), then restart
  • For other IDEs, you may have some luck by installing jedi, which provides code completion for Vim, Emacs, Sublime, Atom, etc.

TODO

Support python versions before 3.5. Currently requires at least 3.5 due to use of type hints.

Credits

pyboto3 for inspiration behind this. It supported only legacy Python and not Python 3. Besides, it is no longer being maintained.

For forkers

Automated releasing on pypi

Deploy the pipeline in your AWS account by clicking this button:

Manual Releasing on pypi

  • docker-compose build
  • docker-compose run python. Enter credentials when prompted

Metadata

Release files for botostubs 0.9.1.9.145

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for botostubs 0.9.1.9.145
File Size Uploaded Provenance Actions
botostubs-0.9.1.9.145.tar.gz 2.1 MB Without provenance Details for botostubs-0.9.1.9.145.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for botostubs 0.9.1.9.145
File Interpreter ABI Platform Actions
botostubs-0.9.1.9.145-py3-none-any.whl Python 3 none any Details for botostubs-0.9.1.9.145-py3-none-any.whl

Total release size: 4.1 MB

Release files / botostubs-0.9.1.9.145.tar.gz

Download URL botostubs-0.9.1.9.145.tar.gz
Size 2.1 MB
Tags Source
SHA-256 checksum
How to use checksums
a16688bd01e242289ec1e57dee833d2b2ba92a4912d3f5d2cc30ed71968bf7a0
BLAKE2b-256 checksum
How to use checksums
faf0bb59817ab084f447fa93930c9a29c608c8c72424abafd569cecacbbe8121
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

Release files / botostubs-0.9.1.9.145-py3-none-any.whl

Download URL botostubs-0.9.1.9.145-py3-none-any.whl
Size 2.1 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b3b3d1d016d9889117cf21dc9a3c71a614c37e60c489704df469b43c337edd34
BLAKE2b-256 checksum
How to use checksums
70a62b5cffa937d1f320d3472b23e92c998d063316f402b2fac5e41856386506
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.1 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

Security for botostubs 0.9.1.9.145

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.9.1.9.145 This release

2 release files No provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page