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

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

botostubs-0.4.1.9.116-py3-none-any.whl (178.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.116.tar.gz
  • Upload date:
  • Size: 177.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.116.tar.gz
Algorithm Hash digest
SHA256 1e8b12f20ae0261f42c96a5fbd7c10514706b9a492f99cc1fffda63fd89269e1
MD5 0e63f2a9065fa8cfaf832faf4c6c70d2
BLAKE2b-256 30b2ba2199e43d2fc138c0ba38914f0e4abd4b4441c807ecad1c2713141b81c8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.116-py3-none-any.whl
  • Upload date:
  • Size: 178.3 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.116-py3-none-any.whl
Algorithm Hash digest
SHA256 ee5cdaa69d065b1e8ccb4425fe23bcf1547cbdb1a1a69ee28412ca999b3d71ef
MD5 25cb8a5e4fe09bb24f53b83b97b67ea3
BLAKE2b-256 a727ade9a4dab124b524591ffacb209c59a4e577032dbdbff667312cc8a3aaf8

See more details on using hashes here.

Supported by

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