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.4.1.9.106.tar.gz (175.6 kB view details)

Uploaded Source

Built Distribution

botostubs-0.4.1.9.106-py3-none-any.whl (176.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.106.tar.gz
  • Upload date:
  • Size: 175.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for botostubs-0.4.1.9.106.tar.gz
Algorithm Hash digest
SHA256 208ad224fb8fffa181276b1fb664887d4c7f8463980a00fc649fa8d70a3d3893
MD5 bdbf13c41e9a112f4eeb3bea79799e8f
BLAKE2b-256 25bb5d7105aec789937703753bf6ab3627b3f071b79f45017a1c4a9bffaaee99

See more details on using hashes here.

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.106-py3-none-any.whl
  • Upload date:
  • Size: 176.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/40.8.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.6.5

File hashes

Hashes for botostubs-0.4.1.9.106-py3-none-any.whl
Algorithm Hash digest
SHA256 326e877ccccc3903f6d793f522f88957ea90b4df35931553d8ae76c60035a74b
MD5 cf44f5c1d94f47176ae53fe0028876bc
BLAKE2b-256 be1f68befd7c476792f1d27415a913a6251a39525bb6e685f49cf001f337ff8e

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