boto3-assist


Nameboto3-assist JSON
Version 0.15.0 PyPI version JSON
download
home_pageNone
SummaryAdditional boto3 wrappers to make your life a little easier
upload_time2025-05-07 02:41:37
maintainerNone
docs_urlNone
authorNone
requires_python>=3.10
licenseNone
keywords
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # boto3 assist

[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)

This is in beta and subject to changes before it's initial 1.0.0 release

This libary was created to make life a little easier when using boto3.

Currently it supports:
- User Authentication / Session Mapping
- DynamoDB model mapping and key generation.


## User Authentication / Session Mapping
Have you ever needed an easy way to load your sessions for a local, dev or production enviroment? Well this library
makes it a little easier by lazy loading your boto3 session so that tools like `python-dotenv` can be used to load your
environment vars first and then load your session.

## DyamoDB model mapping and Key Generation
It's a light weight mapping tool to turn your python classes / object models to DynamoDB items that are ready
for saving.  See the [examples](https://github.com/geekcafe/boto3-assist/tree/main/examples) directory in the repo for more information.


```sh
python -m vevn .venv
source ./.venv/bin/activate

pip install --upgrade pip  
pip install boto3-assist

```

## Running Unit Tests
Several of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  

For your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.

Since we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:

```toml
[profile moto-mock-tests]
region = us-east-1
output = json
aws_access_key_id = test
aws_secret_access_key = test

```


            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "boto3-assist",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.10",
    "maintainer_email": null,
    "keywords": null,
    "author": null,
    "author_email": "Eric Wilson <boto3-assist@geekcafe.com>",
    "download_url": "https://files.pythonhosted.org/packages/48/b5/4f80d855c03852d5ecdbe2c629e192363f513663c86558d01cff0c2a0a4e/boto3_assist-0.15.0.tar.gz",
    "platform": null,
    "description": "# boto3 assist\n\n[![PyPI version](https://img.shields.io/pypi/v/boto3-assist.svg)](https://pypi.org/project/boto3-assist/)\n[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)\n[![Downloads](https://static.pepy.tech/badge/boto3-assist)](https://pepy.tech/project/boto3-assist)\n\nThis is in beta and subject to changes before it's initial 1.0.0 release\n\nThis libary was created to make life a little easier when using boto3.\n\nCurrently it supports:\n- User Authentication / Session Mapping\n- DynamoDB model mapping and key generation.\n\n\n## User Authentication / Session Mapping\nHave you ever needed an easy way to load your sessions for a local, dev or production enviroment? Well this library\nmakes it a little easier by lazy loading your boto3 session so that tools like `python-dotenv` can be used to load your\nenvironment vars first and then load your session.\n\n## DyamoDB model mapping and Key Generation\nIt's a light weight mapping tool to turn your python classes / object models to DynamoDB items that are ready\nfor saving.  See the [examples](https://github.com/geekcafe/boto3-assist/tree/main/examples) directory in the repo for more information.\n\n\n```sh\npython -m vevn .venv\nsource ./.venv/bin/activate\n\npip install --upgrade pip  \npip install boto3-assist\n\n```\n\n## Running Unit Tests\nSeveral of our tests use a mocking library to simulate connections to S3, DynamoDB, etc.  In order to use those tests, you will need to have a `.env.unittest` file at the root of this project (which our tests will attempt to locate and load).  \n\nFor your convenince the `.evn.unittest` file has been added to this project.  The values should not point to live AWS profiles, instead it should use the values added.\n\nSince we also point to a profile, you should create the profile in the `~/.aws/config` file.  The entry should look like the following:\n\n```toml\n[profile moto-mock-tests]\nregion = us-east-1\noutput = json\naws_access_key_id = test\naws_secret_access_key = test\n\n```\n\n",
    "bugtrack_url": null,
    "license": null,
    "summary": "Additional boto3 wrappers to make your life a little easier",
    "version": "0.15.0",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "07ab4285d582cfd97268448ccf6d6b51c2de74aadbc3385d20272ab28766b03d",
                "md5": "1ee8d1bf6fc06ec9105bceddca3c6194",
                "sha256": "c2738f69d006aa7550149703a81a9b7e77da5b278e823ccbeea2c550fd515621"
            },
            "downloads": -1,
            "filename": "boto3_assist-0.15.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "1ee8d1bf6fc06ec9105bceddca3c6194",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.10",
            "size": 85178,
            "upload_time": "2025-05-07T02:41:36",
            "upload_time_iso_8601": "2025-05-07T02:41:36.662157Z",
            "url": "https://files.pythonhosted.org/packages/07/ab/4285d582cfd97268448ccf6d6b51c2de74aadbc3385d20272ab28766b03d/boto3_assist-0.15.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "48b54f80d855c03852d5ecdbe2c629e192363f513663c86558d01cff0c2a0a4e",
                "md5": "af8ca50d674dea37db660803d21b07db",
                "sha256": "5afb15f3d8edd32205986379723b366956b99878265d287ffc1c352d283d9ada"
            },
            "downloads": -1,
            "filename": "boto3_assist-0.15.0.tar.gz",
            "has_sig": false,
            "md5_digest": "af8ca50d674dea37db660803d21b07db",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.10",
            "size": 93193,
            "upload_time": "2025-05-07T02:41:37",
            "upload_time_iso_8601": "2025-05-07T02:41:37.631565Z",
            "url": "https://files.pythonhosted.org/packages/48/b5/4f80d855c03852d5ecdbe2c629e192363f513663c86558d01cff0c2a0a4e/boto3_assist-0.15.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-05-07 02:41:37",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "boto3-assist"
}
        
Elapsed time: 0.66582s