Metadata-Version: 2.2
Name: jarboto
Version: 1.1.0
Summary: JARVICE container environment config wrapper for boto3
Home-page: https://github.com/nimbix/jarboto
Download-URL: https://github.com/nimbix/jarboto/archive/v1.1.0.tar.gz
Author: Nimbix, Inc.
Author-email: noreply@nimbix.net
License: LICENSE.txt
Keywords: s3,boto3,JARVICE
Classifier: Development Status :: 5 - Production/Stable
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Build Tools
Classifier: License :: OSI Approved :: BSD License
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Description-Content-Type: text/markdown
License-File: LICENSE.txt
Requires-Dist: boto3
Dynamic: author
Dynamic: author-email
Dynamic: classifier
Dynamic: description
Dynamic: description-content-type
Dynamic: download-url
Dynamic: home-page
Dynamic: keywords
Dynamic: license
Dynamic: requires-dist
Dynamic: summary

# jarboto
JARVICE container environment config wrapper for boto3

# Environment configuration
The following values are mandatory:
* `JARVICE_S3_ACCESSKEY`
* `JARVICE_S3_SECRETKEY`
* `JARVICE_S3_BUCKET`

Note that the `jarboto.S3` constructor throws `jarboto.ConfigError` if one of these values is not set

The following values are optional:
* `JARVICE_S3_ENDPOINTURL` (defaults to AWS)
* `JARVICE_S3_PREFIX` (defaults to `output/`)
* `JARVICE_S3_REGION` (defaults to None)

# Usage
Typical usage pattern when looking to conditionally fetch objects either from S3 or from another source:

```python
import jarboto

try:
    buf = jarboto.S3().get(name)
except jarboto.ConfigError:

    # alternate method to fetch object follows
    # ...

except jarboto.S3Error as e:

    # actually failed to fetch object
    print(e)
```

Notes:
* Keep `S3` object if you intend to perform multiple operations in that context.
* Run `pydoc jarboto.S3` for additional help on method use.

