# aio-aws
[![Build Status](https://github.com/dazza-codes/aio-aws/actions/workflows/python-test.yml/badge.svg)](https://github.com/dazza-codes/aio-aws/actions/workflows/python-test.yml)
[![Documentation Status](https://readthedocs.org/projects/aio-aws/badge/?version=latest)](https://aio-aws.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://img.shields.io/pypi/v/aio-aws.svg)](https://pypi.org/project/aio-aws)
[![Python versions](https://img.shields.io/pypi/pyversions/aio-aws.svg)](https://pypi.org/project/aio-aws)
Asynchronous functions and tools for AWS services. There is a
limited focus on s3 and AWS Batch and Lambda. Additional services could be
added, but this project is likely to retain a limited focus.
For general client solutions, see
[aioboto3](https://github.com/terrycain/aioboto3) and
[aiobotocore](https://github.com/aio-libs/aiobotocore), which wrap
[botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html)
The API documentation is at [readthedocs](https://aio-aws.readthedocs.io/)
# Install
This project has a very limited focus. For general client solutions, see
[aioboto3](https://github.com/terrycain/aioboto3) and
[aiobotocore](https://github.com/aio-libs/aiobotocore), which wrap
[botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html)
to patch it with features for async coroutines using
[aiohttp](https://aiohttp.readthedocs.io/en/latest/) and
[asyncio](https://docs.python.org/3/library/asyncio.html).
This project is alpha-status with a 0.x.y API version that could break.
There is no promise to support or develop it extensively, at this time.
## pip
```shell
pip install -U aio-aws[all]
pip check # pip might not guarantee consistent packages
```
## poetry
poetry will try to guarantee consistent packages or fail.
```shell
# with optional extras
poetry add aio-aws --extras all
```
```toml
# pyproject.toml snippet
[tool.poetry.dependencies]
python = "^3.7"
# with optional extras
aio-aws = {version = "^0.1.0", extras = ["all"]}
# or, to make it an optional extra
aio-aws = {version = "^0.1.0", extras = ["all"], optional = true}
[tool.poetry.extras]
aio-aws = ["aio-aws"]
```
# Contributing
To use the source code, it can be cloned directly. Contributions are welcome
via github flow and pull requests. To contribute to the project, first fork
it and clone the forked repository.
The following setup assumes that
[miniconda3](https://docs.conda.io/en/latest/miniconda.html) and
[poetry](https://python-poetry.org/docs/) are installed already
(and `make` 4.x).
- https://docs.conda.io/en/latest/miniconda.html
- recommended for creating virtual environments with required versions of python
- see https://github.com/dazza-codes/conda-venv
- https://python-poetry.org/docs/
- recommended for managing a python project with pip dependencies for
both the project itself and development dependencies
```shell
git clone https://github.com/dazza-codes/aio-aws
cd aio-aws
conda create -n aio-aws python=3.8
conda activate aio-aws
make init # calls poetry install
make test
```
Note: on OSX, install GNU make >= 4.x using homebrew and substitute
`gmake` for `make`.
## Release Versions
Install [pipx](https://pypa.github.io/pipx/) and use it to install
[versionner](https://msztolcman.github.io/versionner/).
```shell
pipx install versionner
ver --help
```
With `pipx` and `versionner` installed, it can be used to manage releases
for any python library. See the documentation for `ver` for details on
how to manage sem-ver library releases. See `.versionner.rc` file for
details of the project configuration.
# License
```text
Copyright 2019-2023 Darren Weber
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
```
# Notices
Inspiration for this project comes from various open source projects that use
the Apache 2 license, including but not limited to:
- Apache Airflow: https://github.com/apache/airflow
- aiobotocore: https://github.com/aio-libs/aiobotocore
- botocore: https://github.com/boto/botocore
Raw data
{
"_id": null,
"home_page": "https://github.com/dazza-codes/aio-aws",
"name": "aio-aws",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8,<4.0",
"maintainer_email": "",
"keywords": "Development Status :: 3 - Alpha,Topic :: Utilities,Intended Audience :: Developers,Operating System :: OS Independent,Programming Language :: Python,Programming Language :: Python :: 3,Programming Language :: Python :: 3.8,Programming Language :: Python :: 3.9,Programming Language :: Python :: 3.10,Programming Language :: Python :: 3.11,Programming Language :: Python :: 3 :: Only,License :: OSI Approved :: Apache Software License",
"author": "Darren Weber",
"author_email": "dazza-codes@github.com",
"download_url": "https://files.pythonhosted.org/packages/cb/12/0ac8e07d902091de1b6f05f31ca541c0248c61baa4d8cbd3498027143f62/aio_aws-0.22.1.tar.gz",
"platform": null,
"description": "# aio-aws\n\n[![Build Status](https://github.com/dazza-codes/aio-aws/actions/workflows/python-test.yml/badge.svg)](https://github.com/dazza-codes/aio-aws/actions/workflows/python-test.yml)\n[![Documentation Status](https://readthedocs.org/projects/aio-aws/badge/?version=latest)](https://aio-aws.readthedocs.io/en/latest/?badge=latest)\n\n[![PyPI version](https://img.shields.io/pypi/v/aio-aws.svg)](https://pypi.org/project/aio-aws)\n[![Python versions](https://img.shields.io/pypi/pyversions/aio-aws.svg)](https://pypi.org/project/aio-aws)\n\nAsynchronous functions and tools for AWS services. There is a\nlimited focus on s3 and AWS Batch and Lambda. Additional services could be\nadded, but this project is likely to retain a limited focus.\nFor general client solutions, see\n[aioboto3](https://github.com/terrycain/aioboto3) and\n[aiobotocore](https://github.com/aio-libs/aiobotocore), which wrap\n[botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html)\n\nThe API documentation is at [readthedocs](https://aio-aws.readthedocs.io/)\n\n# Install\n\nThis project has a very limited focus. For general client solutions, see\n[aioboto3](https://github.com/terrycain/aioboto3) and\n[aiobotocore](https://github.com/aio-libs/aiobotocore), which wrap\n[botocore](https://botocore.amazonaws.com/v1/documentation/api/latest/index.html)\nto patch it with features for async coroutines using\n[aiohttp](https://aiohttp.readthedocs.io/en/latest/) and\n[asyncio](https://docs.python.org/3/library/asyncio.html).\n\nThis project is alpha-status with a 0.x.y API version that could break.\nThere is no promise to support or develop it extensively, at this time.\n\n## pip\n\n```shell\npip install -U aio-aws[all]\npip check # pip might not guarantee consistent packages\n```\n\n## poetry\n\npoetry will try to guarantee consistent packages or fail.\n\n```shell\n# with optional extras\npoetry add aio-aws --extras all\n```\n\n```toml\n# pyproject.toml snippet\n\n[tool.poetry.dependencies]\npython = \"^3.7\"\n\n# with optional extras\naio-aws = {version = \"^0.1.0\", extras = [\"all\"]}\n\n# or, to make it an optional extra\naio-aws = {version = \"^0.1.0\", extras = [\"all\"], optional = true}\n[tool.poetry.extras]\naio-aws = [\"aio-aws\"]\n\n```\n\n# Contributing\n\nTo use the source code, it can be cloned directly. Contributions are welcome\nvia github flow and pull requests. To contribute to the project, first fork\nit and clone the forked repository.\n\nThe following setup assumes that\n[miniconda3](https://docs.conda.io/en/latest/miniconda.html) and\n[poetry](https://python-poetry.org/docs/) are installed already\n(and `make` 4.x).\n\n- https://docs.conda.io/en/latest/miniconda.html\n - recommended for creating virtual environments with required versions of python\n - see https://github.com/dazza-codes/conda-venv\n- https://python-poetry.org/docs/\n - recommended for managing a python project with pip dependencies for\n both the project itself and development dependencies\n\n```shell\ngit clone https://github.com/dazza-codes/aio-aws\ncd aio-aws\nconda create -n aio-aws python=3.8\nconda activate aio-aws\nmake init # calls poetry install\nmake test\n```\n\nNote: on OSX, install GNU make >= 4.x using homebrew and substitute\n`gmake` for `make`.\n\n## Release Versions\n\nInstall [pipx](https://pypa.github.io/pipx/) and use it to install\n[versionner](https://msztolcman.github.io/versionner/).\n\n```shell\npipx install versionner\nver --help\n```\n\nWith `pipx` and `versionner` installed, it can be used to manage releases\nfor any python library. See the documentation for `ver` for details on\nhow to manage sem-ver library releases. See `.versionner.rc` file for\ndetails of the project configuration.\n\n# License\n\n```text\nCopyright 2019-2023 Darren Weber\n\nLicensed under the Apache License, Version 2.0 (the \"License\");\nyou may not use this file except in compliance with the License.\nYou may obtain a copy of the License at\n\n http://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing, software\ndistributed under the License is distributed on an \"AS IS\" BASIS,\nWITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.\nSee the License for the specific language governing permissions and\nlimitations under the License.\n```\n\n# Notices\n\nInspiration for this project comes from various open source projects that use\nthe Apache 2 license, including but not limited to:\n- Apache Airflow: https://github.com/apache/airflow\n- aiobotocore: https://github.com/aio-libs/aiobotocore\n- botocore: https://github.com/boto/botocore\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "aio-aws",
"version": "0.22.1",
"project_urls": {
"Homepage": "https://github.com/dazza-codes/aio-aws",
"Repository": "https://github.com/dazza-codes/aio-aws.git"
},
"split_keywords": [
"development status :: 3 - alpha",
"topic :: utilities",
"intended audience :: developers",
"operating system :: os independent",
"programming language :: python",
"programming language :: python :: 3",
"programming language :: python :: 3.8",
"programming language :: python :: 3.9",
"programming language :: python :: 3.10",
"programming language :: python :: 3.11",
"programming language :: python :: 3 :: only",
"license :: osi approved :: apache software license"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "86f1e90878ebde2e3d9aaad3a8c24fb9d54acca802ab945fb1ddc245bebed02d",
"md5": "c3d3285af4e82748502e3094f4852cf8",
"sha256": "b80bb421d7c5b9baaaa9eb0f3838566d471cc77dfe97083bd5a01a7656918e24"
},
"downloads": -1,
"filename": "aio_aws-0.22.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c3d3285af4e82748502e3094f4852cf8",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8,<4.0",
"size": 71257,
"upload_time": "2023-06-28T03:28:38",
"upload_time_iso_8601": "2023-06-28T03:28:38.495111Z",
"url": "https://files.pythonhosted.org/packages/86/f1/e90878ebde2e3d9aaad3a8c24fb9d54acca802ab945fb1ddc245bebed02d/aio_aws-0.22.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cb120ac8e07d902091de1b6f05f31ca541c0248c61baa4d8cbd3498027143f62",
"md5": "49392dd04a8ee7f5fb195fe413218370",
"sha256": "1f5f6736bf83345f517d4813237272cc67545325267850c244d1e36c23c2928e"
},
"downloads": -1,
"filename": "aio_aws-0.22.1.tar.gz",
"has_sig": false,
"md5_digest": "49392dd04a8ee7f5fb195fe413218370",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8,<4.0",
"size": 58472,
"upload_time": "2023-06-28T03:28:40",
"upload_time_iso_8601": "2023-06-28T03:28:40.163930Z",
"url": "https://files.pythonhosted.org/packages/cb/12/0ac8e07d902091de1b6f05f31ca541c0248c61baa4d8cbd3498027143f62/aio_aws-0.22.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-28 03:28:40",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dazza-codes",
"github_project": "aio-aws",
"travis_ci": true,
"coveralls": false,
"github_actions": true,
"lcname": "aio-aws"
}