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.125.tar.gz (178.8 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.125-py3-none-any.whl (179.5 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.125.tar.gz
  • Upload date:
  • Size: 178.8 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.125.tar.gz
Algorithm Hash digest
SHA256 083b68fc0ab78928c787a6cab9cd6dfa673ff7cbe8d2f86a1210a96dc1f20e95
MD5 d680a821cebae2a0c8cdd37781abaf9b
BLAKE2b-256 d71a7278c61bf85e927838f9c42a617060daafb2e3baaffcd4faf5f52f8a2328

See more details on using hashes here.

File details

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

File metadata

  • Download URL: botostubs-0.4.1.9.125-py3-none-any.whl
  • Upload date:
  • Size: 179.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.125-py3-none-any.whl
Algorithm Hash digest
SHA256 3f8b37df5286713d3aaca28f79590a19db4d24cfe210231bf4195af4515c91f8
MD5 1920e8bf89662adf2fee1eea1b87a8ff
BLAKE2b-256 336f6b28ab69ae73d6d6d986faedb699a676554960b2cbc032810c1e1e57a9cf

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