Skip to main content

boto3 code assistance for any API in any IDE, always up to date

Project description

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=30000 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.6. Currently requires at least 3.6 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:

This is how it looks like:

stack

Image automatically generated with cfnbuddy

Manual Releasing on pypi

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

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

botostubs-0.14.1.20.37.tar.gz (4.2 MB view details)

Uploaded Source

Built Distribution

botostubs-0.14.1.20.37-py3-none-any.whl (4.3 MB view details)

Uploaded Python 3

File details

Details for the file botostubs-0.14.1.20.37.tar.gz.

File metadata

  • Download URL: botostubs-0.14.1.20.37.tar.gz
  • Upload date:
  • Size: 4.2 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/57.5.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.15

File hashes

Hashes for botostubs-0.14.1.20.37.tar.gz
Algorithm Hash digest
SHA256 2cfef32f587720702ef229813cd5b2a738cd4e6cd656824251f6887c913da924
MD5 696cce5bdec9dbc3294df8f16c58b31d
BLAKE2b-256 3076737a3069b2aa39f15d9921a926b8ec1ef5bd4863dcf780d60f00c7a376d7

See more details on using hashes here.

File details

Details for the file botostubs-0.14.1.20.37-py3-none-any.whl.

File metadata

  • Download URL: botostubs-0.14.1.20.37-py3-none-any.whl
  • Upload date:
  • Size: 4.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/57.5.0 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.15

File hashes

Hashes for botostubs-0.14.1.20.37-py3-none-any.whl
Algorithm Hash digest
SHA256 d98aca3128294305f483d17d5f6fdfa0c189bfcc482b56c5711bb66316be3ade
MD5 12823ed99346a83ba385db47f92fe6cb
BLAKE2b-256 1dd33498ada35b3428bebd1a2ec73b57008dfecdf521b7535d3700f467838be3

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page