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
  • full api coverage

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.

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

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.5.1.9.134.tar.gz (1.9 MB view details)

Uploaded Source

Built Distribution

botostubs-0.5.1.9.134-py3-none-any.whl (2.0 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botostubs-0.5.1.9.134.tar.gz
  • Upload date:
  • Size: 1.9 MB
  • Tags: Source
  • Uploaded using 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

File hashes

Hashes for botostubs-0.5.1.9.134.tar.gz
Algorithm Hash digest
SHA256 a24c54a4bd09a703a588e6275398deb3b85f54a2cad0ab126c9125d2ed6628e9
MD5 730c299f162e01304888918f7e4cc5a3
BLAKE2b-256 65340a0087102ebc57f4d5137346242fc4fb517a0c5a980bde9ddcaa57a8fc11

See more details on using hashes here.

File details

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

File metadata

  • Download URL: botostubs-0.5.1.9.134-py3-none-any.whl
  • Upload date:
  • Size: 2.0 MB
  • Tags: Python 3
  • Uploaded using 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

File hashes

Hashes for botostubs-0.5.1.9.134-py3-none-any.whl
Algorithm Hash digest
SHA256 239d8633b48a8be236d21b3b5e4f2800d8d813928825ea0cee2e6048164f0e93
MD5 0bec4610aaf615773fec1188f6b4badf
BLAKE2b-256 d93939cfc51408c4b3211e25f1d500159111d13f0cec2cb4cb82139ee6f9d75e

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