py-jugaad-aws


Namepy-jugaad-aws JSON
Version 0.0.4 PyPI version JSON
download
home_page
SummaryPython libraries to ease development of APIs and event driven apps for AWS serverless architecture
upload_time2024-01-08 04:02:03
maintainer
docs_urlNone
author
requires_python>=3.9
licenseMIT License Copyright (c) 2023 Aditya Aluru Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
keywords jugaad serverless aws event driven apis scaffolding
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            # py-jugaad-aws

The Jugaad libraries are designed to be minimalist but effective in providing essential frameworks to help build multi-tenant SaaS platforms.

The python libraries in this package ease development of APIs and event driven apps for AWS serverless architecture and is primarily tested with AWS Chalice framework.

## Usage Guide

### Logging

```
from jugaad_aws import log
logger = log.STLogger.getLogger(__name__)
logger.info("useful logs...")
```
The logger instance created above is same as the logger instance available from the package `logging`

### App Configuration

```
from jugaad_aws import config
testvalue = config.getStaticConfig("testKey","DEFAULT_VALUE")
testDynValue = config.getDynamicConfig("testDynKey","DEFAULT_VALUE")
```
The config instance has two main methods:

* `getStaticConfig` - This method looks for the provided configuration key (`testKey` in the example above) in the following sequence:
    * Under the specific path within AWS Parameter Store - `/APP_CONFIG_STATIC/<App Name>/`. The app name is read from a `config.ini` file present under the app root folder.
    * Environment variable
    * A `config.ini` under the root folder of the app.
An optional `DEFAULT_VALUE` can be provided to the method to return the default if the configuration is not found in any of the mentioned locations.

* `getDynamicConfig` - This method looks for the provided configuration key (`testDynKey` in the example above) from the AWS Parameter Store - `/APP_CONFIG_DYNAMIC/<App Name>`. The app name is read from a `config.ini` file present under the app root folder.

### HTTP Client

### Middleware

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "py-jugaad-aws",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9",
    "maintainer_email": "",
    "keywords": "jugaad,serverless,aws,event driven,apis,scaffolding",
    "author": "",
    "author_email": "Aditya Aluru <aditya.aluru@gmail.com>",
    "download_url": "https://files.pythonhosted.org/packages/52/19/7314d35df8c516ac7d567290563fe4d4ef33a1bf7895b069650e4f24c385/py_jugaad_aws-0.0.4.tar.gz",
    "platform": null,
    "description": "# py-jugaad-aws\r\n\r\nThe Jugaad libraries are designed to be minimalist but effective in providing essential frameworks to help build multi-tenant SaaS platforms.\r\n\r\nThe python libraries in this package ease development of APIs and event driven apps for AWS serverless architecture and is primarily tested with AWS Chalice framework.\r\n\r\n## Usage Guide\r\n\r\n### Logging\r\n\r\n```\r\nfrom jugaad_aws import log\r\nlogger = log.STLogger.getLogger(__name__)\r\nlogger.info(\"useful logs...\")\r\n```\r\nThe logger instance created above is same as the logger instance available from the package `logging`\r\n\r\n### App Configuration\r\n\r\n```\r\nfrom jugaad_aws import config\r\ntestvalue = config.getStaticConfig(\"testKey\",\"DEFAULT_VALUE\")\r\ntestDynValue = config.getDynamicConfig(\"testDynKey\",\"DEFAULT_VALUE\")\r\n```\r\nThe config instance has two main methods:\r\n\r\n* `getStaticConfig` - This method looks for the provided configuration key (`testKey` in the example above) in the following sequence:\r\n    * Under the specific path within AWS Parameter Store - `/APP_CONFIG_STATIC/<App Name>/`. The app name is read from a `config.ini` file present under the app root folder.\r\n    * Environment variable\r\n    * A `config.ini` under the root folder of the app.\r\nAn optional `DEFAULT_VALUE` can be provided to the method to return the default if the configuration is not found in any of the mentioned locations.\r\n\r\n* `getDynamicConfig` - This method looks for the provided configuration key (`testDynKey` in the example above) from the AWS Parameter Store - `/APP_CONFIG_DYNAMIC/<App Name>`. The app name is read from a `config.ini` file present under the app root folder.\r\n\r\n### HTTP Client\r\n\r\n### Middleware\r\n",
    "bugtrack_url": null,
    "license": "MIT License  Copyright (c) 2023 Aditya Aluru  Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:  The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.  THE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. ",
    "summary": "Python libraries to ease development of APIs and event driven apps for AWS serverless architecture",
    "version": "0.0.4",
    "project_urls": {
        "Homepage": "https://github.com/adityaaluru/py-jugaad-aws"
    },
    "split_keywords": [
        "jugaad",
        "serverless",
        "aws",
        "event driven",
        "apis",
        "scaffolding"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "61f4ca2bd0c0286559d7db378a47be6165cba1c136be66bd26f5d0cfe32c4ac9",
                "md5": "26375bb02e7c871a3826c7000767554c",
                "sha256": "50f5a44d667ff46605c8bd5da5a382aad065f699c62882040481de3a2bf1ee43"
            },
            "downloads": -1,
            "filename": "py_jugaad_aws-0.0.4-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "26375bb02e7c871a3826c7000767554c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9",
            "size": 10950,
            "upload_time": "2024-01-08T04:02:01",
            "upload_time_iso_8601": "2024-01-08T04:02:01.528903Z",
            "url": "https://files.pythonhosted.org/packages/61/f4/ca2bd0c0286559d7db378a47be6165cba1c136be66bd26f5d0cfe32c4ac9/py_jugaad_aws-0.0.4-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "52197314d35df8c516ac7d567290563fe4d4ef33a1bf7895b069650e4f24c385",
                "md5": "104ecfd017dac01b10641fe5c044ecaf",
                "sha256": "6805b88971714835389a03e196519d85e544a0293c381e0ba49c9351cf9af08a"
            },
            "downloads": -1,
            "filename": "py_jugaad_aws-0.0.4.tar.gz",
            "has_sig": false,
            "md5_digest": "104ecfd017dac01b10641fe5c044ecaf",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9",
            "size": 10230,
            "upload_time": "2024-01-08T04:02:03",
            "upload_time_iso_8601": "2024-01-08T04:02:03.283464Z",
            "url": "https://files.pythonhosted.org/packages/52/19/7314d35df8c516ac7d567290563fe4d4ef33a1bf7895b069650e4f24c385/py_jugaad_aws-0.0.4.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2024-01-08 04:02:03",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "adityaaluru",
    "github_project": "py-jugaad-aws",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": false,
    "requirements": [],
    "lcname": "py-jugaad-aws"
}
        
Elapsed time: 0.16010s