boto3 code assistance for any API in any IDE, always up to date
Project description
botostubs
Gives you code assistance for any boto3 API in any IDE. Get started by running pip install botostubs
Demo
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=20000in 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:
Image automatically generated with cfnbuddy
Manual Releasing on pypi
docker-compose builddocker-compose run python. Enter credentials when prompted
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
Built Distribution
File details
Details for the file botostubs-0.12.1.14.43.tar.gz.
File metadata
- Download URL: botostubs-0.12.1.14.43.tar.gz
- Upload date:
- Size: 3.0 MB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/49.3.1 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 38909cab6b11b6ba6bd155f977882ffccce1079755374e20ac58fbd827fa2b06 |
|
| MD5 | 8946ac8eb22b7280f6f14d09cba9e7e8 |
|
| BLAKE2b-256 | ae916b1fda60e8fef8e458d6dbe4bcca92bd5d82e5d8fd72477516a4d397f54a |
File details
Details for the file botostubs-0.12.1.14.43-py3-none-any.whl.
File metadata
- Download URL: botostubs-0.12.1.14.43-py3-none-any.whl
- Upload date:
- Size: 3.0 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/49.3.1 requests-toolbelt/0.9.1 tqdm/4.42.0 CPython/3.6.11
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 01347706da9a82e6a8c6d97514c4574f14dc96ba41518abf9ca367ec5fec84e5 |
|
| MD5 | 705f962017b48d79a466900fb529e6d0 |
|
| BLAKE2b-256 | 59af7838dd539b0f5f736c1d48a4ee0ad7439b2d764b700c3aeb877625e86689 |
