single |
botocore
========
A low-level interface to a growing number of Amazon Web Services. The
botocore package is the foundation for the
[AWS CLI] as well as
[boto3].
On 10/29/2020 deprecation for Python 3.4 and Python 3.5 was announced and
support
will be dropped on 02/01/2021. To avoid disruption, customers using
Botocore
on Python 3.4 or 3.5 may need to upgrade their version of Python or pin the
version of Botocore in use prior to 02/01/2021. For more information, see
this [blog post].
Getting Started
---------------
Assuming that you have Python and virtualenv installed, set up your
environment and install the required dependencies like this or you can
install the library using pip:
.. code-block:: sh
$ git clone https://github.com/boto/botocore.git
$ cd botocore
$ virtualenv venv
...
$ . venv/bin/activate
$ pip install -r requirements.txt
$ pip install -e .
.. code-block:: sh
$ pip install botocore
Using Botocore
~~~~~~~~~~~~~~
After installing botocore
Next, set up credentials (in e.g. ``~/.aws/credentials``):
.. code-block:: ini
[default]
aws_access_key_id = YOUR_KEY
aws_secret_access_key = YOUR_SECRET
Then, set up a default region (in e.g. ``~/.aws/config``):
.. code-block:: ini
[default]
region=us-east-1
Other credentials configuration method can be found [here]
Then, from a Python interpreter:
.. code-block:: python
>>> import botocore.session
>>> session = botocore.session.get_session()
>>> client = session.create_client('ec2')
>>> print(client.describe_instances())
Getting Help
------------
We use GitHub issues for tracking bugs and feature requests and have
limited
bandwidth to address them. Please use these community resources for getting
help. Please note many of the same resources available for boto3 are
applicable for botocore:
* Ask a question on [Stack Overflow] and tag it with [boto3]
* Come join the AWS Python community chat on [gitter]
* Open a support ticket with [AWS Support]
* If it turns out that you may have found a bug, please [open an issue]
Contributing
------------
We value feedback and contributions from our community. Whether it's a bug
report, new feature, correction, or additional documentation, we welcome
your issues and pull requests. Please read through this [CONTRIBUTING]
document before submitting any issues or pull requests to ensure we have
all the necessary information to effectively respond to your contribution.
More Resources
--------------
* [NOTICE]
* [Changelog]
* [License]
|