aibs-informatics-cdk-lib 0.0.3__tar.gz

aibs_informatics_cdk_lib-0.0.3/LICENSE

@@ -0,0 +1,33 @@
+Allen Institute Software License – This software license is the 2-clause BSD 
+license plus a third clause that prohibits redistribution and use for 
+commercial purposes without further permission. 
+
+Copyright © 2024. Allen Institute.  All rights reserved.
+
+Redistribution and use in source and binary forms, with or without 
+modification, are permitted provided that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this 
+list of conditions and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, 
+this list of conditions and the following disclaimer in the documentation 
+and/or other materials provided with the distribution.
+
+3. Redistributions and use for commercial purposes are not permitted without 
+the Allen Institute’s written permission. For purposes of this license, 
+commercial purposes are the incorporation of the Allen Institute's software 
+into anything for which you will charge fees or other compensation or use of 
+the software to perform a commercial service for a third party. Contact 
+terms@alleninstitute.org for commercial licensing opportunities.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

aibs_informatics_cdk_lib-0.0.3/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.1
+Name: aibs-informatics-cdk-lib
+Version: 0.0.3
+Summary: CDK Library for AIBS Informatics services
+Author-email: AIBS Informatics Group <marmot@alleninstitute.onmicrosoft.com>
+Maintainer-email: AIBS Informatics Group <marmot@alleninstitute.onmicrosoft.com>
+License: Allen Institute Software License – This software license is the 2-clause BSD 
+        license plus a third clause that prohibits redistribution and use for 
+        commercial purposes without further permission. 
+        
+        Copyright © 2024. Allen Institute.  All rights reserved.
+        
+        Redistribution and use in source and binary forms, with or without 
+        modification, are permitted provided that the following conditions are met:
+        
+        1. Redistributions of source code must retain the above copyright notice, this 
+        list of conditions and the following disclaimer.
+        
+        2. Redistributions in binary form must reproduce the above copyright notice, 
+        this list of conditions and the following disclaimer in the documentation 
+        and/or other materials provided with the distribution.
+        
+        3. Redistributions and use for commercial purposes are not permitted without 
+        the Allen Institute’s written permission. For purposes of this license, 
+        commercial purposes are the incorporation of the Allen Institute's software 
+        into anything for which you will charge fees or other compensation or use of 
+        the software to perform a commercial service for a third party. Contact 
+        terms@alleninstitute.org for commercial licensing opportunities.
+        
+        THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND 
+        ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED 
+        WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE 
+        DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE 
+        FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 
+        DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR 
+        SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER 
+        CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, 
+        OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE 
+        OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
+Project-URL: Documentation, https://.github.io/aibs-informatics-cdk-lib/
+Project-URL: Homepage, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/
+Project-URL: Issues, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/issues
+Project-URL: Repository, https://github.com/AllenInstitute/aibs-informatics-cdk-lib/
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: aibs-informatics-aws-utils
+Requires-Dist: aibs-informatics-core
+Requires-Dist: aws-cdk-lib~=2.96
+Requires-Dist: constructs~=10.0
+Requires-Dist: pydantic~=2.0
+Provides-Extra: dev
+Requires-Dist: aibs-informatics-test-resources; extra == "dev"
+Requires-Dist: boto3-stubs[batch,s3]; extra == "dev"
+Provides-Extra: release
+Requires-Dist: build; extra == "release"
+Requires-Dist: bump-my-version; extra == "release"
+Requires-Dist: wheel; extra == "release"
+
+# AIBS Informatics CDK Library
+
+[![Build Status](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml/badge.svg)](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml)
+
+---
+
+## Overview
+
+The AIBS Informatics CDK Library is a collection of AWS Cloud Development Kit (CDK) constructs and utilities designed to facilitate the deployment and management of cloud infrastructure for the Allen Institute for Brain Science. This library includes constructs for managing AWS Batch environments, Elastic File System (EFS) configurations, CloudWatch dashboards, and more. It aims to provide reusable and configurable components to streamline the development and deployment of cloud-based applications and services.
+
+### Modules
+
+- **Batch**: Constructs for setting up and managing AWS Batch environments, including job queues, compute environments, and monitoring.
+- **EFS**: Utilities and constructs for configuring and managing Elastic File System (EFS) resources.
+- **CloudWatch**: Tools for creating and managing CloudWatch dashboards and alarms.
+- **Service Compute**: Constructs for defining compute resources, including Lambda functions and Batch compute environments.
+- **State Machine Fragments**: Reusable fragments for AWS Step Functions, including batch job submission and data synchronization.
+- **Assets**: Definitions and utilities for managing code assets, including Lambda functions and Docker images.
+- **Core**: Base constructs and utilities used across the library, including environment configurations and common IAM policies.
+
+## Contributing
+
+Any and all PRs are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+## Licensing
+
+This software is licensed under the Allen Institute Software License, which is the 2-clause BSD license plus a third clause that prohibits redistribution and use for commercial purposes without further permission. For more information, please visit [Allen Institute Terms of Use](https://alleninstitute.org/terms-of-use/).

aibs_informatics_cdk_lib-0.0.3/README.md

@@ -0,0 +1,27 @@
+# AIBS Informatics CDK Library
+
+[![Build Status](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml/badge.svg)](https://github.com/AllenInstitute/aibs-informatics-cdk-lib/actions/workflows/build.yml)
+
+---
+
+## Overview
+
+The AIBS Informatics CDK Library is a collection of AWS Cloud Development Kit (CDK) constructs and utilities designed to facilitate the deployment and management of cloud infrastructure for the Allen Institute for Brain Science. This library includes constructs for managing AWS Batch environments, Elastic File System (EFS) configurations, CloudWatch dashboards, and more. It aims to provide reusable and configurable components to streamline the development and deployment of cloud-based applications and services.
+
+### Modules
+
+- **Batch**: Constructs for setting up and managing AWS Batch environments, including job queues, compute environments, and monitoring.
+- **EFS**: Utilities and constructs for configuring and managing Elastic File System (EFS) resources.
+- **CloudWatch**: Tools for creating and managing CloudWatch dashboards and alarms.
+- **Service Compute**: Constructs for defining compute resources, including Lambda functions and Batch compute environments.
+- **State Machine Fragments**: Reusable fragments for AWS Step Functions, including batch job submission and data synchronization.
+- **Assets**: Definitions and utilities for managing code assets, including Lambda functions and Docker images.
+- **Core**: Base constructs and utilities used across the library, including environment configurations and common IAM policies.
+
+## Contributing
+
+Any and all PRs are welcome. Please see [CONTRIBUTING.md](CONTRIBUTING.md) for more information.
+
+## Licensing
+
+This software is licensed under the Allen Institute Software License, which is the 2-clause BSD license plus a third clause that prohibits redistribution and use for commercial purposes without further permission. For more information, please visit [Allen Institute Terms of Use](https://alleninstitute.org/terms-of-use/).

aibs_informatics_cdk_lib-0.0.3/pyproject.toml

@@ -0,0 +1,256 @@
+# -----------------------------------------------------------------------------
+##  Build System Configurations
+#   https://setuptools.pypa.io/en/latest/setuptools.html#building-and-distributing-packages-with-setuptools
+# -----------------------------------------------------------------------------
+
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aibs-informatics-cdk-lib"
+authors = [{ name = "AIBS Informatics Group", email = "marmot@alleninstitute.onmicrosoft.com"}]
+maintainers = [{ name = "AIBS Informatics Group", email = "marmot@alleninstitute.onmicrosoft.com"}]
+description = "CDK Library for AIBS Informatics services"
+readme = { file = "README.md", content-type = "text/markdown" }
+license = { file = "LICENSE" }
+requires-python = ">=3.9"
+dynamic = [
+    "version",
+]
+dependencies = [
+    "aibs-informatics-aws-utils",
+    "aibs-informatics-core",
+    "aws-cdk-lib~=2.96",
+    "constructs~=10.0",
+    "pydantic~=2.0",
+]
+
+[project.optional-dependencies]
+dev = [
+    "aibs-informatics-test-resources",
+    "boto3-stubs[s3,batch]",
+]
+
+release = [
+    "build",
+    "bump-my-version",
+    "wheel",
+]
+
+[tool.setuptools.dynamic]
+version = {attr = "aibs_informatics_cdk_lib._version.__version__"}
+
+[tool.setuptools.package-data]
+"*" = [
+    'py.typed',
+    '*.sh',
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+
+[project.urls]
+Documentation = "https://.github.io/aibs-informatics-cdk-lib/"
+Homepage = "https://github.com/AllenInstitute/aibs-informatics-cdk-lib/"
+Issues = "https://github.com/AllenInstitute/aibs-informatics-cdk-lib/issues"
+Repository = "https://github.com/AllenInstitute/aibs-informatics-cdk-lib/"
+
+
+# -----------------------------------------------------------------------------
+##  Pyright Configurations
+#   https://github.com/microsoft/pyright/blob/main/docs/configuration.md
+# -----------------------------------------------------------------------------
+
+[tool.pyright]
+reportGeneralTypeIssues = false
+typeCheckingMode = "basic"
+
+# -----------------------------------------------------------------------------
+##  Coverage Configurations 
+#   https://coverage.readthedocs.io/en/7.0.4/config.html#
+# -----------------------------------------------------------------------------
+
+[tool.coverage]
+# Note: we use pytest-cov to generate coverage reports
+#       when running tests. but these coverage configs
+#       are read when doing so.  
+[tool.coverage.run]
+branch = true
+command_line = "coverage -m pytest"
+data_file = "build/.coverage"
+source = [
+    "src/"
+]
+
+[tool.coverage.report]
+omit = [
+    "test/*"
+]
+exclude_lines = [
+    'pragma: no cover',
+    'raise NotImplementedError',
+    'if TYPE_CHECKING:',
+    'if typing.TYPE_CHECKING:',
+    '@overload',
+    '@typing.overload',
+    '\(Protocol\):$',
+    'typing.assert_never',
+    'assert_never',
+]
+skip_empty = true
+
+[tool.coverage.html]
+directory = "build/documentation/coverage"
+
+[tool.coverage.xml]
+output = "build/documentation/coverage.xml"
+
+# -----------------------------------------------------------------------------
+##  pytest Configurations
+#   https://docs.pytest.org/en/7.2.x/reference/customize.html
+# -----------------------------------------------------------------------------
+
+[tool.pytest.ini_options]
+minversion = "6.0"
+addopts = [
+    "-ra", 
+    "--verbose",
+    "--ignore=build/private",
+    # Coverage options should be managed in the .coveragerc file.
+    # The below configurations simply enable coverage and reporting.  
+    "--cov", 
+    "--cov-report=term-missing",
+    "--cov-report=html",
+    "--cov-report=xml",
+    "--cov-fail-under=0",
+    "--color=yes",
+] 
+testpaths = [
+    "test",
+]
+cache_dir = "build/.pytest_cache"
+  
+# -----------------------------------------------------------------------------
+##  MyPy Configurations
+#   https://mypy.readthedocs.io/en/stable/config_file.html#example-pyproject-toml
+# -----------------------------------------------------------------------------
+
+[tool.mypy]
+exclude = '''(?x)(
+    assets/
+    | build/
+    | cdk.out/
+    | setup.py$
+    | test/
+)'''
+
+cache_dir = "build/.mypy_cache"
+
+# Using no incremental to avoid known issue with mypy and some packages:
+# https://github.com/python/mypy/issues/9852
+incremental = false
+
+# Import Discovery
+# https://mypy.readthedocs.io/en/stable/config_file.html#import-discovery
+ignore_missing_imports = true
+follow_imports = "silent"
+no_site_packages = true
+
+# Untyped definitions and calls
+# https://mypy.readthedocs.io/en/stable/config_file.html#untyped-definitions-and-calls
+# TODO: enable and fix errors
+check_untyped_defs = true
+
+
+# Miscellaneous strictness flags
+# https://mypy.readthedocs.io/en/latest/config_file.html#miscellaneous-strictness-flags
+allow_redefinition = true
+
+
+# Configuring Error Messages
+# https://mypy.readthedocs.io/en/stable/config_file.html#configuring-error-messages
+show_error_codes = true
+color_output = true
+pretty = true
+show_absolute_path = false
+
+# Reporting Generation
+# https://mypy.readthedocs.io/en/stable/config_file.html#report-generation
+# [DEBUG] UNCOMMENT FOR DEBUG PURPOSES ONLY! Type coverage impacts test 
+# html_report = build/documentation/mypy/
+# xml_report = build/documentation/mypy/
+# cobertura_xml_report = build/documentation/mypy/
+
+# None and Optional handling
+# https://mypy.readthedocs.io/en/latest/config_file.html#none-and-optional-handling
+strict_optional = false
+
+# Miscellaneous
+# https://mypy.readthedocs.io/en/latest/config_file.html#miscellaneous
+# [DEBUG] If you need to better understand type error, increase verbosity
+verbosity = 0
+
+[[tool.mypy.overrides]]
+module = [
+    "src.*",
+    "test.*"
+]
+ignore_errors = false
+
+
+# -----------------------------------------------------------------------------
+##  Black Configurations
+#   https://black.readthedocs.io/en/stable/usage_and_configuration/the_basics.html#what-on-earth-is-a-pyproject-toml-file
+# -----------------------------------------------------------------------------
+
+
+[tool.black]
+line-length = 99
+include = '\.pyi?$'
+extend-exclude = '''
+/(
+  # The following are specific to Black, you probably don't want those.
+  | cdk.out
+)/
+'''
+
+# -----------------------------------------------------------------------------
+##  isort Configurations
+#   https://pycqa.github.io/isort/docs/configuration/config_files.html
+# -----------------------------------------------------------------------------
+
+[tool.isort]
+# required for compatibility with black:
+line_length = 99
+profile = "black"
+src_paths = ["src", "test"]
+skip = [".venv", "build", "cdk.out"]
+
+# -----------------------------------------------------------------------------
+##  bumpversion Configurations
+#   https://callowayproject.github.io/bump-my-version/
+# -----------------------------------------------------------------------------
+
+[tool.bumpversion]
+allow_dirty = false
+commit = true
+commit_args = ""
+current_version = "0.0.3"
+ignore_missing_version = false
+message = "Bump version: {current_version} → {new_version}"
+parse = "(?P<major>\\d+)\\.(?P<minor>\\d+)\\.(?P<patch>\\d+)"
+regex = false
+replace = "{new_version}"
+search = "{current_version}"
+serialize = ["{major}.{minor}.{patch}"]
+sign_tags = false
+tag = true
+tag_message = "Bump version: {current_version} → {new_version}"
+tag_name = "v{new_version}"
+
+[[tool.bumpversion.files]]
+filename = "src/aibs_informatics_cdk_lib/_version.py"
+search = "__version__ = \"{current_version}\""
+replace = "__version__ = \"{new_version}\""

aibs_informatics_cdk_lib-0.0.3/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

aibs_informatics_cdk_lib-0.0.3/src/aibs_informatics_cdk_lib/__init__.py

@@ -0,0 +1,2 @@
+__version_info__ = (0, 0, 1)
+__version__ = ".".join(map(str, __version_info__))

aibs_informatics_cdk_lib-0.0.3/src/aibs_informatics_cdk_lib/_version.py

@@ -0,0 +1 @@
+__version__ = "0.0.3"