Metadata-Version: 2.1
Name: bolt-sdk-py2
Version: 1.0.2
Summary: Bolt Python SDK
Home-page: https://github.com/projectn-oss/projectn-bolt-python2
Author: Project N
License: UNKNOWN
Description: # Bolt SDK
        
        This SDK provides an authentication solution for programatically interacting with Bolt. It wraps the boto3 interface so project wide integration is as easy as refactoring `import boto3` to `import bolt as boto3`.
        
        The package affects the signing and routing protocol of the boto3 S3 client, therefore any non S3 clients created through this SDK will be un-affected by the wrapper.
        
        ## Prerequisites
        
        The minimum supported version of Python is version 2.
        
        ## Installation
        
        ```bash
        python -m pip install bolt-sdk-py2
        ```
        
        ## Configuration
        
        For the client to work it must have knowledge of Bolt's *service discovery url* (`BOLT_URL`)
        These are parameterized by the *region* of Bolt's deployment. A preferred *availability zone ID* can also be provided for AZ-aware routing.
        
        **Expose Bolt's URL to the SDK:**
        1. Declare the ENV variable: `BOLT_CUSTOM_DOMAIN`, which constructs Bolt URL and hostname based on default naming
        ```bash
        export BOLT_CUSTOM_DOMAIN="example.com"
        ```
        
        
        **There are two ways to expose Bolt's region/preferred availability zone to the SDK:**
        
        If running on an EC2 instance, the SDK will use the instance's region and availability zone id, unless overriden with environment variables: `BOLT_REGION` and `BOLT_AZ_ID`
        
        ```bash
        export BOLT_REGION='<region>'
        export BOLT_AZ_ID='<az-id>'
        ```
        
        ## Example usage
        
        ```python
        import bolt
        # Create an S3 client
        s3_client = bolt.client("s3")
        # Define a function that performs the put_object operation
        s3_client.put_object(Body="data", Bucket="BUCKET_NAME", Key="key")
        obj = s3_client.get_object(Bucket="BUCKET_NAME", Key="key")
        body = obj["Body"].read()
        ```
        ## Debugging
        
        Import the default logger and set its level to DEBUG
        
        `logging.getLogger().setLevel(logging.DEBUG)`
        
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 2
Classifier: Operating System :: OS Independent
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Topic :: Software Development :: Libraries
Requires-Python: >=2.7
Description-Content-Type: text/markdown
