lambda-api-decorators-cdk 0.2.3__py3-none-any.whl

lambda_api_decorators_cdk/source_layout.py

@@ -0,0 +1,8 @@
+from enum import Enum
+
+
+class SourceLayout(Enum):
+    """The source boundary used to package discovered Lambda handlers."""
+
+    ROOT = "root"
+    SERVICE = "service"

lambda_api_decorators_cdk-0.2.3.dist-info/METADATA

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: lambda-api-decorators-cdk
+Version: 0.2.3
+Summary: AWS CDK integration for Lambda API Decorators. Generate AWS Lambda and API Gateway infrastructure from decorated Python handlers.
+Author: Mateo Marcos, Emanuel Arguinarena, Lucas Picchi
+License: MIT License
+        
+        Copyright (c) 2024 Lambda API Decorators CDK
+        
+        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.
+Project-URL: Homepage, https://github.com/lambda-api-decorators/lambda-api-decorators-cdk
+Project-URL: Repository, https://github.com/lambda-api-decorators/lambda-api-decorators-cdk
+Project-URL: Bug Reports, https://github.com/lambda-api-decorators/lambda-api-decorators-cdk
+Keywords: cdk,lambda,aws,api gateway,ast
+Classifier: Development Status :: 2 - Pre-Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: AWS CDK :: 2
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aws-cdk.aws-lambda-python-alpha
+Dynamic: license-file
+
+# Lambda API Decorators CDK
+
+## A library for AWS API Gateway/Lambda Proxy Integration
+
+Lambda API Decorators CDK allows simplified resource creation for AWS Lambda functions and Rest API resources by using decorators and setting a builder with default, common or custom values for IAM Roles, Runtimes, Timeouts, Layers, Environment values, etc. This project relies abstract syntactic trees (ast) to analyze the code of your lambda functions and generate infraestructure accordingly.
+
+### Installation
+
+`lambda_api_decorators_cdk` is available from PyPI as `lambda-api-decorators-cdk`:
+
+    pip install lambda-api-decorators-cdk
+
+Installation of [lambda-api-decorators](https://pypi.org/project/lambda-api-decorators/) is also required as a dependency for your lambda functions, since it provides the definition of decorators used within this module.
+
+
+### Example
+
+```python
+    import lambda_api_decorators_cdk
+    or
+    from lambda_api_decorators_cdk import ResourceBuilder
+```
+
+### Builder instance
+
+You may define a builder using lambda_api_decorators_cdk's constructor `ResourceBuilder`. This method returns an instance of the class that will be used to configure and create your Lambda Functions. By default, no parameters are required to instantiate the object, but custom options may be passed in advanced use cases.
+
+```python
+    from lambda_api_decorators_cdk import ResourceBuilder
+
+    builder = ResourceBuilder()
+```
+
+### Builder Configuration
+
+If opted to, you can set default values for IAM Roles, Memory Size, Timeout, Runtime and VPC.
+
+On the same note, support for common configuration that all the Lambda Functions will receive, such as Security Groups, Environment variables and Layers, is provided.
+
+Lastly you can setup custom environments, layers, security groups, vpcs a Lambda Function will receive ONLY if they have the decorators defined.
+
+```python
+    from lambda_api_decorators_cdk import ResourceBuilder
+    from aws_cdk import Duration
+
+    builder = ResourceBuilder()
+    builder.set_default_timeout(Duration.seconds(30))
+    builder.add_common_environment("DATABASE_URI", "something-db-related")
+    builder.add_custom_environment("URL-PREFIX", "lambda-api-decorators-cdk-") #Lambda Function should have decorator @environment("URL-PREFIX")
+```
+
+### Building
+
+Assuming you have already instantiated a Builder, configured it and ready to deploy your stack, then simply define the directory of your Lambda Functions and build!
+
+Note: For a Lambda Function to be recognised and built, it has to have a decorator specifying the HTTP method it responds to. Decorators are defined in the [lambda-api-decorators](https://pypi.org/project/lambda-api-decorators/) package.
+
+```python
+[...] # Imports
+
+class LambdaApiDecoratorsExampleStack(Stack):
+
+    def __init__(self, scope: Construct, construct_id: str, **kwargs) -> None:
+        super().__init__(scope, construct_id, **kwargs)
+
+        [...]  # Instantiating builder, defining options and layers...
+
+        lambda_path = 'lambdas'
+
+        restapi = apigateway.RestApi(
+            self, 'lambda-api-decorators-RestApi',
+            rest_api_name= 'lambda-api-decorators-restApi')
+        root_resource = restapi.root
+
+        builder.build(self, root_resource, lambda_path, print_tree=True)
+
+```
+
+## Maintainer releases
+
+The Git tag is the single source of truth for this package's version. For
+example, `v0.3.0` produces Python package version `0.3.0`. This repository is
+versioned independently from `lambda-api-decorators`.
+
+To release from `main`, choose and push a semantic version tag:
+
+```bash
+git checkout main
+git pull
+
+git tag v0.3.0
+git push origin v0.3.0
+```
+
+Pushing the tag triggers the release workflow, which tests, builds, verifies
+the version, and publishes with PyPI trusted publishing. The PyPI project must
+have a trusted publisher configured for this repository, the `release.yml`
+workflow, and the `pypi` GitHub environment.

lambda_api_decorators_cdk-0.2.3.dist-info/RECORD

@@ -0,0 +1,12 @@
+lambda_api_decorators_cdk/__init__.py,sha256=LkPu_ySBeRlGKVYbeLV86H78kYFrEQHBuzmskZo3nf8,197
+lambda_api_decorators_cdk/api_type.py,sha256=UjhwP6KBwILl7NpL17e4mL-Bi5JdcfDs3oq2bxoESL0,146
+lambda_api_decorators_cdk/ast_helper.py,sha256=zx1albQktG5D3Rlf5eXEJXiwoZsPF7qwEgTb_sATGEg,14978
+lambda_api_decorators_cdk/lambda_api.py,sha256=wqiwe10-XOuPG8kxn2YGcpk4IHag1WG6mMHFENLgRhc,3148
+lambda_api_decorators_cdk/lambda_api_config.py,sha256=Ngi0g-tN-M9ifv8xrX3UQqjA2RxtVmf6ejqhkYc2nNo,6103
+lambda_api_decorators_cdk/resource_builder.py,sha256=IRYlILYasYywF1_kua-zNHYxG2jGJn4qF5QeAoJqFEQ,36350
+lambda_api_decorators_cdk/source_layout.py,sha256=rvw2D0UTOyhHmiCg_NTuxFf2wvsFCBugnwNKd3NLWLo,167
+lambda_api_decorators_cdk-0.2.3.dist-info/licenses/LICENSE,sha256=kABKIBEzZQqtNkBsAA9tA_Ume6OKdVUnChslMCL2Baw,1081
+lambda_api_decorators_cdk-0.2.3.dist-info/METADATA,sha256=9vYl2q28NItUYeN16dmg4bzqKZgM1tF38KJ3Mf6DBq8,6434
+lambda_api_decorators_cdk-0.2.3.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+lambda_api_decorators_cdk-0.2.3.dist-info/top_level.txt,sha256=1goCGc19BssxULn6ejZNLDYP0sQHEyqCMhivbGjxDCE,26
+lambda_api_decorators_cdk-0.2.3.dist-info/RECORD,,

lambda_api_decorators_cdk-0.2.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

lambda_api_decorators_cdk-0.2.3.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Lambda API Decorators CDK
+
+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.

lambda_api_decorators_cdk-0.2.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+lambda_api_decorators_cdk