diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000000..826378380e --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +## Code of Conduct +This project has adopted the [Amazon Open Source Code of Conduct](https://aws.github.io/code-of-conduct). +For more information see the [Code of Conduct FAQ](https://aws.github.io/code-of-conduct-faq) or contact +opensource-codeofconduct@amazon.com with any additional questions or comments. + diff --git a/CONTRIBUTING.rst b/CONTRIBUTING.rst index 936aa599fc..d1ce496ee2 100644 --- a/CONTRIBUTING.rst +++ b/CONTRIBUTING.rst @@ -28,20 +28,19 @@ contributions as well: In practice, this means that every bug fix and feature addition should include unit tests. * We may choose not to accept pull requests that change the JSON service descriptions, - such as ``botocore/data/aws/s3/2006-03-01/service-2.json``. We generate these - files upstream based on our internal knowledge of the AWS services. If there - is something incorrect with or missing from a service description, it may be - more appropriate to submit an - `issue `__ so we can get the issue - fixed upstream. This constraint only applies to the ``*/service-2.json`` files. - We do accept, and encourage, changes to any of the following files - in ``botocore/data/aws/``: - + such as ``botocore/data/aws/s3/2006-03-01/service-2.json`` and changes to any of the + following files in ``botocore/data/``: + * ``_endpoints.json`` - * ``_retry.json`` * ``*.paginators-1.json`` * ``*.waiters-2.json`` + We generate these files upstream based on our internal knowledge of the AWS services. + If there is something incorrect with or missing from these files, it may be + more appropriate to submit an + `issue `__ so we can get the issue + fixed upstream. This constraint only applies to the above mentioned files. + We do accept, and encourage, changes to the ``botocore/data/_retry.json`` file. * Code should follow `pep 8 `__, although if you are modifying an existing module, it is more important for the code to be consistent if there are any discrepancies. diff --git a/README.rst b/README.rst index 4241d77ca0..6cb7da8f46 100644 --- a/README.rst +++ b/README.rst @@ -19,10 +19,53 @@ on Python 2.6 or 3.3 will need to upgrade their version of Python or pin the version of Botocore in use prior to 01/10/2020. 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``: -Documentation -------------- -Documentation for ``botocore`` can be found `here `__. +.. 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 @@ -37,3 +80,18 @@ applicable for ``botocore``: * 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 `__ + diff --git a/docs/README.rst b/docs/README.rst new file mode 100644 index 0000000000..5f18e7c412 --- /dev/null +++ b/docs/README.rst @@ -0,0 +1,3 @@ +# Botocore Documentation + +Documentation for botocore can be found [here](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html)