aind-settings-utils 0.0.1__tar.gz

aind_settings_utils-0.0.1/.flake8

@@ -0,0 +1,8 @@
+[flake8]
+exclude =
+    .git,
+    __pycache__,
+    build,
+    .venv,
+    venv
+max-complexity = 10

aind_settings_utils-0.0.1/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,38 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

aind_settings_utils-0.0.1/.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

aind_settings_utils-0.0.1/.github/ISSUE_TEMPLATE/user-story.md

@@ -0,0 +1,27 @@
+---
+name: User story
+about: This template provides a basic structure for user story issues.
+title: ''
+labels: ''
+assignees: ''
+
+---
+
+# User story
+As a ..., I want to ..., so I can ...
+
+*Ideally, this is in the issue title, but if not, you can put it here. If so, delete this section.*
+
+# Acceptance criteria
+- [ ] This is something that can be verified to show that this user story is satisfied.
+
+# Sprint Ready Checklist 
+- [ ] 1. Acceptance criteria defined 
+- [ ] 2. Team understands acceptance criteria 
+- [ ] 3. Team has defined solution / steps to satisfy acceptance criteria 
+- [ ] 4. Acceptance criteria is verifiable / testable 
+- [ ] 5. External / 3rd Party dependencies identified
+- [ ] 6. Ticket is prioritized and sized
+
+# Notes
+*Add any helpful notes here.*

aind_settings_utils-0.0.1/.github/workflows/tag_and_publish.yml

@@ -0,0 +1,84 @@
+name: Tag and publish
+on:
+  push:
+    branches:
+      - main
+jobs:
+  update_badges:
+    runs-on: ubuntu-latest
+    continue-on-error: true
+    steps:
+    - uses: actions/checkout@v4
+      with:
+        ref: ${{ env.DEFAULT_BRANCH }}
+        fetch-depth: 0
+        token: ${{ secrets.SERVICE_TOKEN }}
+    - name: Set up Python 3.10
+      uses: actions/setup-python@v5
+      with:
+        python-version: '3.10'
+    - name: Install dependencies
+      run: | 
+        python -m pip install -e .[dev] --no-cache-dir
+    - name: Get Python version and Update README.md
+      run: |
+        python_version=$(grep "requires-python" pyproject.toml | grep -o ">=[^\"]*")
+        python_badge=$(grep -o 'python-[^)]*' README.md)
+        new_python_badge="python-$python_version-blue?logo=python"
+        sed -i "s/$python_badge/$new_python_badge/g" README.md
+    - name: Get interrogate values and Update README.md
+      run: |
+        interrogate_val=$(interrogate . | grep -o 'actual: [0-9]*\.[0-9]*' | awk '{print $2}')
+        interrogate_badge=$(grep -o 'interrogate-[^)]*' README.md)
+        if (( $(echo "$interrogate_val >= 90.00" | bc -l) )); then
+            new_interrogate_badge="interrogate-$interrogate_val%25-brightgreen"
+        elif (( $(echo "$interrogate_val < 80.00" | bc -l) )); then
+            new_interrogate_badge="interrogate-$interrogate_val%25-red"
+        else
+            new_interrogate_badge="interrogate-$interrogate_val%25-yellow"
+        fi
+        sed -i "s/$interrogate_badge/$new_interrogate_badge/g" README.md
+    - name: Get Coverage values and Update README.md
+      run: |
+        coverage run -m unittest discover
+        coverage_val=$(coverage report | grep "^TOTAL" | grep -o '[0-9]\+%' | grep -o '[0-9]\+')
+        coverage_badge=$(grep -o "coverage-[^?]*" README.md)
+        if (( $(echo "$coverage_val >= 90.00" | bc -l) )); then 
+            new_coverage_badge="coverage-$coverage_val%25-brightgreen"
+        elif (( $(echo "$coverage_val < 80.00" | bc -l) )); then
+            new_coverage_badge="coverage-$coverage_val%25-red"
+        else
+            new_coverage_badge="coverage-$coverage_val%25-yellow"
+        fi
+        sed -i "s/$coverage_badge/$new_coverage_badge/g" README.md
+    - name: Commit changes
+      uses: EndBug/add-and-commit@v9
+      with:
+        default_author: github_actions
+        message: "ci: update badges [skip actions]"
+        add: '["README.md"]'
+  tag:
+    needs: update_badges
+    uses: AllenNeuralDynamics/aind-github-actions/.github/workflows/tag.yml@main
+    secrets:
+      SERVICE_TOKEN: ${{ secrets.SERVICE_TOKEN }}
+  publish:
+    needs: tag
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - name: Pull latest changes
+        run: git pull origin main
+      - name: Set up Python 3.10
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.10'
+      - name: Install dependencies
+        run: |
+          pip install --upgrade setuptools wheel twine build
+          python -m build
+          twine check dist/*
+      - name: Publish on PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          password: ${{ secrets.AIND_PYPI_TOKEN }}

aind_settings_utils-0.0.1/.github/workflows/test_and_lint.yml

@@ -0,0 +1,26 @@
+name: Lint and run tests
+
+on:
+  pull_request:
+    branches:
+      - main
+
+jobs:
+  ci:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: [ '3.8', '3.9', '3.10', '3.11', '3.12' ]
+    steps:
+    - uses: actions/checkout@v4
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+    - name: Install dependencies
+      run: | 
+        python -m pip install -e .[dev]
+    - name: Run linter checks
+      run: flake8 . && interrogate --verbose .
+    - name: Run tests and coverage
+      run: coverage run -m unittest discover && coverage report

aind_settings_utils-0.0.1/.gitignore

@@ -0,0 +1,139 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+# MacOs
+**/.DS_Store

aind_settings_utils-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 Allen Institute for Neural Dynamics
+
+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.

aind_settings_utils-0.0.1/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: aind-settings-utils
+Version: 0.0.1
+Summary: Generated from aind-library-template
+Author: Allen Institute for Neural Dynamics
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: interrogate; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Dynamic: license-file
+
+# aind-settings-utils
+
+[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+![Code Style](https://img.shields.io/badge/code%20style-black-black)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+![Interrogate](https://img.shields.io/badge/interrogate-100.0%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
+![Python](https://img.shields.io/badge/python->=3.8-blue?logo=python)
+
+
+
+## Usage
+
+This package is intended to be installed as a utility package alongside apps.
+
+### App settings store as a json file in AWS Parameter store.
+
+AWS credentials are handled by boto3.
+
+If you have a parameter in Parameter store under:
+```bash
+/dev/my_param
+```
+
+with contents:
+```
+{"app_name": "my app", "app_arg1": 3}
+```
+
+then you can pull that information into a settings class like:
+```python
+from aind_settings_utils.aws import (
+    ParameterStoreAppBaseSettings,
+)
+
+class ExampleSettings(ParameterStoreAppBaseSettings):
+
+    app_name: str
+    app_arg1: int
+
+    model_config = {
+        "aws_param_store_name": "/dev/my_param",  # Or pull it from an env var
+        "case_sensitive": False,
+    }
+
+```
+
+You can then import and create an `ExampleSettings` class:
+
+```python
+example_settings = ExampleSettings()
+print(example_settings.app_name)
+print(example_settings.app_arg1)
+```
+
+
+## Contributing
+
+Clone this repo and install the development packages locally:
+```bash
+pip install -e ".[dev]"
+```
+
+### Linters and testing
+
+There are several libraries used to run linters, check documentation, and run tests.
+
+- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
+
+```bash
+coverage run -m unittest discover && coverage report
+```
+
+- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:
+
+```bash
+interrogate .
+```
+
+- Use **flake8** to check that code is up to standards (no unused imports, etc.):
+```bash
+flake8 .
+```
+
+- Use **black** to automatically format the code into PEP standards:
+```bash
+black .
+```
+
+- Use **isort** to automatically sort import statements:
+```bash
+isort .
+```
+
+### Pull requests
+
+For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:
+```text
+<type>(<scope>): <short summary>
+```
+
+where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
+
+- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
+- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
+- **docs**: Documentation only changes
+- **feat**: A new feature
+- **fix**: A bugfix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **test**: Adding missing tests or correcting existing tests
+
+### Semantic Release
+
+The table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
+
+| Commit message                                                                                                                                                                                   | Release type                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release, Default release                                                                          |
+| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release                                                                                       |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

aind_settings_utils-0.0.1/README.md

@@ -0,0 +1,121 @@
+# aind-settings-utils
+
+[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+![Code Style](https://img.shields.io/badge/code%20style-black-black)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+![Interrogate](https://img.shields.io/badge/interrogate-100.0%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
+![Python](https://img.shields.io/badge/python->=3.8-blue?logo=python)
+
+
+
+## Usage
+
+This package is intended to be installed as a utility package alongside apps.
+
+### App settings store as a json file in AWS Parameter store.
+
+AWS credentials are handled by boto3.
+
+If you have a parameter in Parameter store under:
+```bash
+/dev/my_param
+```
+
+with contents:
+```
+{"app_name": "my app", "app_arg1": 3}
+```
+
+then you can pull that information into a settings class like:
+```python
+from aind_settings_utils.aws import (
+    ParameterStoreAppBaseSettings,
+)
+
+class ExampleSettings(ParameterStoreAppBaseSettings):
+
+    app_name: str
+    app_arg1: int
+
+    model_config = {
+        "aws_param_store_name": "/dev/my_param",  # Or pull it from an env var
+        "case_sensitive": False,
+    }
+
+```
+
+You can then import and create an `ExampleSettings` class:
+
+```python
+example_settings = ExampleSettings()
+print(example_settings.app_name)
+print(example_settings.app_arg1)
+```
+
+
+## Contributing
+
+Clone this repo and install the development packages locally:
+```bash
+pip install -e ".[dev]"
+```
+
+### Linters and testing
+
+There are several libraries used to run linters, check documentation, and run tests.
+
+- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
+
+```bash
+coverage run -m unittest discover && coverage report
+```
+
+- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:
+
+```bash
+interrogate .
+```
+
+- Use **flake8** to check that code is up to standards (no unused imports, etc.):
+```bash
+flake8 .
+```
+
+- Use **black** to automatically format the code into PEP standards:
+```bash
+black .
+```
+
+- Use **isort** to automatically sort import statements:
+```bash
+isort .
+```
+
+### Pull requests
+
+For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:
+```text
+<type>(<scope>): <short summary>
+```
+
+where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
+
+- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
+- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
+- **docs**: Documentation only changes
+- **feat**: A new feature
+- **fix**: A bugfix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **test**: Adding missing tests or correcting existing tests
+
+### Semantic Release
+
+The table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
+
+| Commit message                                                                                                                                                                                   | Release type                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release, Default release                                                                          |
+| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release                                                                                       |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

aind_settings_utils-0.0.1/pyproject.toml

@@ -0,0 +1,82 @@
+[build-system]
+requires = ["setuptools", "setuptools-scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "aind-settings-utils"
+description = "Generated from aind-library-template"
+license = {text = "MIT"}
+requires-python = ">=3.8"
+authors = [
+    {name = "Allen Institute for Neural Dynamics"}
+]
+classifiers = [
+    "Programming Language :: Python :: 3"
+]
+readme = "README.md"
+dynamic = ["version"]
+
+dependencies = [
+    'boto3',
+    'pydantic-settings>=2.0',
+    'pydantic>=2.0',
+]
+
+[project.optional-dependencies]
+dev = [
+    'black',
+    'coverage',
+    'flake8',
+    'interrogate',
+    'isort',
+    'Sphinx',
+    'furo'
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = {attr = "aind_settings_utils.__version__"}
+
+[tool.black]
+line-length = 79
+target_version = ['py310']
+exclude = '''
+
+(
+  /(
+      \.eggs         # exclude a few common directories in the
+    | \.git          # root of the project
+    | \.hg
+    | \.mypy_cache
+    | \.tox
+    | \.venv
+    | _build
+    | build
+    | dist
+  )/
+  | .gitignore
+)
+'''
+
+[tool.coverage.run]
+omit = ["*__init__*"]
+source = ["aind_settings_utils", "tests"]
+
+[tool.coverage.report]
+exclude_lines = [
+    "if __name__ == .__main__.:",
+    "^from .* import .*",
+    "^import .*",
+    "pragma: no cover"
+]
+fail_under = 100
+
+[tool.isort]
+line_length = 79
+profile = "black"
+
+[tool.interrogate]
+exclude = ["setup.py", "docs", "build"]
+fail-under = 100

aind_settings_utils-0.0.1/setup.cfg

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

aind_settings_utils-0.0.1/setup.py

@@ -0,0 +1,4 @@
+from setuptools import setup
+
+if __name__ == "__main__":
+    setup()

aind_settings_utils-0.0.1/src/aind_settings_utils/__init__.py

@@ -0,0 +1,3 @@
+"""Init package"""
+
+__version__ = "0.0.1"

aind_settings_utils-0.0.1/src/aind_settings_utils/aws.py

@@ -0,0 +1,178 @@
+"""Module to handle custom settings pulled from AWS"""
+
+import functools
+import json
+import logging
+from typing import Any, Dict, Optional, Tuple, Type
+
+import boto3
+from pydantic.fields import FieldInfo
+from pydantic_settings import BaseSettings, PydanticBaseSettingsSource
+from pydantic_settings.sources import PydanticBaseEnvSettingsSource
+
+
+class AWSParamStoreAppSource(PydanticBaseEnvSettingsSource):
+    """
+    Custom source that will pull settings defined in a json file hosted on
+    AWS Parameter Store.
+    """
+
+    # noinspection PyUnresolvedReferences
+    def __init__(
+        self,
+        settings_cls: Type[BaseSettings],
+        aws_param_store_name: Optional[str] = None,
+        case_sensitive: Optional[bool] = None,
+        env_prefix: Optional[str] = None,
+        env_ignore_empty: Optional[bool] = None,
+        env_parse_none_str: Optional[str] = None,
+    ) -> None:
+        """Class constructor"""
+        super().__init__(
+            settings_cls,
+            case_sensitive,
+            env_prefix,
+            env_ignore_empty,
+            env_parse_none_str,
+        )
+        self.aws_param_store_name = (
+            aws_param_store_name
+            if aws_param_store_name is not None
+            else self.config.get("aws_param_store_name")
+        )
+
+    @staticmethod
+    def _get_parameter(parameter_name: str) -> Dict[str, Any]:
+        """
+        Retrieves a parameter file from AWS Param Store
+
+        Parameters
+        ----------
+        parameter_name : str
+          Parameter name as stored in AWS Param Store
+
+        Returns
+        -------
+        Dict[str, Any]
+          Contents of the secret
+
+        """
+        client = boto3.client("ssm")
+        try:
+            response = client.get_parameter(
+                Name=parameter_name, WithDecryption=True
+            )
+        finally:
+            client.close()
+        return json.loads(response["Parameter"]["Value"])
+
+    @functools.cached_property
+    def _json_contents(self):
+        """
+        Cache contents to avoid re-downloading.
+        """
+        contents_from_aws = self._get_parameter(
+            self.config.get("aws_param_store_name")
+        )
+        return contents_from_aws
+
+    @classmethod
+    def find_case_param(
+        cls, json_contents: dict, param_name: str, case_sensitive: bool
+    ) -> Optional[str]:
+        """
+        Find a parameter from a json dictionary pulled from aws
+
+        Parameters
+        ----------
+        json_contents: dict
+        param_name: str
+        case_sensitive: bool
+          Whether to search for param name case sensitively.
+
+        Returns
+        -------
+        str | None
+          The parameter pulled from the json object or None if not found.
+        """
+
+        if json_contents.get(param_name) is not None:
+            return json_contents.get(param_name)
+        elif (
+            not case_sensitive
+            and json_contents.get(param_name.upper()) is not None
+        ):
+            return json_contents.get(param_name.upper())
+        else:
+            return None
+
+    def get_field_value(
+        self, field: FieldInfo, field_name: str
+    ) -> Tuple[Any, str, bool]:
+        """
+        Gets the value for field from secret file and a flag to determine
+        whether value is complex.
+
+        Parameters
+        ----------
+        field: FieldInfo
+        field_name: str
+
+        Returns
+        -------
+        Tuple[Any, str, bool]
+          A tuple contains the key, value if the file exists otherwise `None`,
+          and a flag to determine whether the value is complex.
+        """
+        param = None
+        field_key = ""
+        value_is_complex = False
+        for field_key, env_name, value_is_complex in self._extract_field_info(
+            field, field_name
+        ):
+            param = self.find_case_param(
+                self._json_contents, env_name, self.case_sensitive
+            )
+            if param:
+                return param, field_key, value_is_complex
+            else:
+                logging.debug(f"param not found {field_key}")
+
+        return param, field_key, value_is_complex
+
+
+class ParameterStoreAppBaseSettings(BaseSettings):
+    """
+    Custom Settings class to handle app settings stored as a json file hosted
+    on AWS Parameter Store.
+    """
+
+    @classmethod
+    def settings_customise_sources(
+        cls,
+        settings_cls: Type[BaseSettings],
+        init_settings: PydanticBaseSettingsSource,
+        env_settings: PydanticBaseSettingsSource,
+        dotenv_settings: PydanticBaseSettingsSource,
+        file_secret_settings: PydanticBaseSettingsSource,
+    ) -> Tuple[PydanticBaseSettingsSource, ...]:
+        """
+        If the param store name is not set, then use standard fallbacks. If
+        param store name is set, then prioritize the values stored there.
+        """
+
+        if settings_cls.model_config.get("aws_param_store_name") is None:
+            return (
+                init_settings,
+                env_settings,
+                dotenv_settings,
+                file_secret_settings,
+            )
+        else:
+            return (
+                init_settings,
+                AWSParamStoreAppSource(settings_cls),
+                env_settings,
+                dotenv_settings,
+                file_secret_settings,
+            )

aind_settings_utils-0.0.1/src/aind_settings_utils.egg-info/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: aind-settings-utils
+Version: 0.0.1
+Summary: Generated from aind-library-template
+Author: Allen Institute for Neural Dynamics
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: boto3
+Requires-Dist: pydantic-settings>=2.0
+Requires-Dist: pydantic>=2.0
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: coverage; extra == "dev"
+Requires-Dist: flake8; extra == "dev"
+Requires-Dist: interrogate; extra == "dev"
+Requires-Dist: isort; extra == "dev"
+Requires-Dist: Sphinx; extra == "dev"
+Requires-Dist: furo; extra == "dev"
+Dynamic: license-file
+
+# aind-settings-utils
+
+[![License](https://img.shields.io/badge/license-MIT-brightgreen)](LICENSE)
+![Code Style](https://img.shields.io/badge/code%20style-black-black)
+[![semantic-release: angular](https://img.shields.io/badge/semantic--release-angular-e10079?logo=semantic-release)](https://github.com/semantic-release/semantic-release)
+![Interrogate](https://img.shields.io/badge/interrogate-100.0%25-brightgreen)
+![Coverage](https://img.shields.io/badge/coverage-100%25-brightgreen?logo=codecov)
+![Python](https://img.shields.io/badge/python->=3.8-blue?logo=python)
+
+
+
+## Usage
+
+This package is intended to be installed as a utility package alongside apps.
+
+### App settings store as a json file in AWS Parameter store.
+
+AWS credentials are handled by boto3.
+
+If you have a parameter in Parameter store under:
+```bash
+/dev/my_param
+```
+
+with contents:
+```
+{"app_name": "my app", "app_arg1": 3}
+```
+
+then you can pull that information into a settings class like:
+```python
+from aind_settings_utils.aws import (
+    ParameterStoreAppBaseSettings,
+)
+
+class ExampleSettings(ParameterStoreAppBaseSettings):
+
+    app_name: str
+    app_arg1: int
+
+    model_config = {
+        "aws_param_store_name": "/dev/my_param",  # Or pull it from an env var
+        "case_sensitive": False,
+    }
+
+```
+
+You can then import and create an `ExampleSettings` class:
+
+```python
+example_settings = ExampleSettings()
+print(example_settings.app_name)
+print(example_settings.app_arg1)
+```
+
+
+## Contributing
+
+Clone this repo and install the development packages locally:
+```bash
+pip install -e ".[dev]"
+```
+
+### Linters and testing
+
+There are several libraries used to run linters, check documentation, and run tests.
+
+- Please test your changes using the **coverage** library, which will run the tests and log a coverage report:
+
+```bash
+coverage run -m unittest discover && coverage report
+```
+
+- Use **interrogate** to check that modules, methods, etc. have been documented thoroughly:
+
+```bash
+interrogate .
+```
+
+- Use **flake8** to check that code is up to standards (no unused imports, etc.):
+```bash
+flake8 .
+```
+
+- Use **black** to automatically format the code into PEP standards:
+```bash
+black .
+```
+
+- Use **isort** to automatically sort import statements:
+```bash
+isort .
+```
+
+### Pull requests
+
+For internal members, please create a branch. For external members, please fork the repository and open a pull request from the fork. We'll primarily use [Angular](https://github.com/angular/angular/blob/main/CONTRIBUTING.md#commit) style for commit messages. Roughly, they should follow the pattern:
+```text
+<type>(<scope>): <short summary>
+```
+
+where scope (optional) describes the packages affected by the code changes and type (mandatory) is one of:
+
+- **build**: Changes that affect build tools or external dependencies (example scopes: pyproject.toml, setup.py)
+- **ci**: Changes to our CI configuration files and scripts (examples: .github/workflows/ci.yml)
+- **docs**: Documentation only changes
+- **feat**: A new feature
+- **fix**: A bugfix
+- **perf**: A code change that improves performance
+- **refactor**: A code change that neither fixes a bug nor adds a feature
+- **test**: Adding missing tests or correcting existing tests
+
+### Semantic Release
+
+The table below, from [semantic release](https://github.com/semantic-release/semantic-release), shows which commit message gets you which release type when `semantic-release` runs (using the default configuration):
+
+| Commit message                                                                                                                                                                                   | Release type                                                                                                    |
+| ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------- |
+| `fix(pencil): stop graphite breaking when too much pressure applied`                                                                                                                             | ~~Patch~~ Fix Release, Default release                                                                          |
+| `feat(pencil): add 'graphiteWidth' option`                                                                                                                                                       | ~~Minor~~ Feature Release                                                                                       |
+| `perf(pencil): remove graphiteWidth option`<br><br>`BREAKING CHANGE: The graphiteWidth option has been removed.`<br>`The default graphite width of 10mm is always used for performance reasons.` | ~~Major~~ Breaking Release <br /> (Note that the `BREAKING CHANGE: ` token must be in the footer of the commit) |

aind_settings_utils-0.0.1/src/aind_settings_utils.egg-info/SOURCES.txt

@@ -0,0 +1,20 @@
+.flake8
+.gitignore
+LICENSE
+README.md
+pyproject.toml
+setup.py
+.github/ISSUE_TEMPLATE/bug_report.md
+.github/ISSUE_TEMPLATE/feature_request.md
+.github/ISSUE_TEMPLATE/user-story.md
+.github/workflows/tag_and_publish.yml
+.github/workflows/test_and_lint.yml
+src/aind_settings_utils/__init__.py
+src/aind_settings_utils/aws.py
+src/aind_settings_utils.egg-info/PKG-INFO
+src/aind_settings_utils.egg-info/SOURCES.txt
+src/aind_settings_utils.egg-info/dependency_links.txt
+src/aind_settings_utils.egg-info/requires.txt
+src/aind_settings_utils.egg-info/top_level.txt
+tests/__init__.py
+tests/test_aws.py

aind_settings_utils-0.0.1/src/aind_settings_utils.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

aind_settings_utils-0.0.1/src/aind_settings_utils.egg-info/requires.txt

@@ -0,0 +1,12 @@
+boto3
+pydantic-settings>=2.0
+pydantic>=2.0
+
+[dev]
+black
+coverage
+flake8
+interrogate
+isort
+Sphinx
+furo

aind_settings_utils-0.0.1/src/aind_settings_utils.egg-info/top_level.txt

@@ -0,0 +1 @@
+aind_settings_utils

aind_settings_utils-0.0.1/tests/__init__.py

@@ -0,0 +1 @@
+"""Testing library"""

aind_settings_utils-0.0.1/tests/test_aws.py

@@ -0,0 +1,137 @@
+"""Module to test custom settings"""
+
+import unittest
+from unittest.mock import MagicMock, PropertyMock, patch
+
+from aind_settings_utils.aws import (
+    AWSParamStoreAppSource,
+    ParameterStoreAppBaseSettings,
+)
+
+
+class ExampleSettings(ParameterStoreAppBaseSettings):
+    """Example settings class for testing"""
+
+    my_secret: str
+
+    model_config = {
+        "aws_param_store_name": "example-name",
+        "case_sensitive": False,
+    }
+
+
+class TestAWSParamStoreSource(unittest.TestCase):
+    """Test AWSParamStoreAppSource class"""
+
+    @patch("aind_settings_utils.aws.boto3.client")
+    def test_get_parameter(self, mock_boto_client: MagicMock):
+        """Tests that parameter is retrieved as expected"""
+        # Mock response
+        mock_ssm = MagicMock()
+        mock_ssm.get_parameter.return_value = {
+            "Parameter": {"Value": '{"my_secret": "secret_value"}'}
+        }
+        mock_boto_client.return_value = mock_ssm
+
+        result = AWSParamStoreAppSource._get_parameter("example-name")
+        self.assertEqual(result, {"my_secret": "secret_value"})
+        mock_ssm.get_parameter.assert_called_once_with(
+            Name="example-name", WithDecryption=True
+        )
+        mock_ssm.close.assert_called_once()
+
+    def test_find_case_param(self):
+        """Tests that correct parameter is found in json dictionary"""
+
+        json_contents = {"keyOne": "value1", "KEYTWO": "value2"}
+        result1 = AWSParamStoreAppSource.find_case_param(
+            json_contents, "keyOne", case_sensitive=False
+        )
+        result2 = AWSParamStoreAppSource.find_case_param(
+            json_contents, "keytwo", case_sensitive=False
+        )
+        result3 = AWSParamStoreAppSource.find_case_param(
+            json_contents, "keytwo", case_sensitive=True
+        )
+
+        self.assertEqual(result1, "value1")
+        self.assertEqual(result2, "value2")
+        self.assertIsNone(result3)
+
+    @patch("aind_settings_utils.aws.boto3.client")
+    def test_get_field_value_success(self, mock_boto_client: MagicMock):
+        """Tests that field value is retrieved successfully"""
+
+        mock_ssm = MagicMock()
+        mock_ssm.get_parameter.return_value = {
+            "Parameter": {"Value": '{"MY_SECRET": "top_secret"}'}
+        }
+        mock_boto_client.return_value = mock_ssm
+        source = AWSParamStoreAppSource(
+            ExampleSettings, aws_param_store_name="example-store-name"
+        )
+        field = ExampleSettings.model_fields["my_secret"]
+
+        value, key, is_complex = source.get_field_value(field, "my_secret")
+        self.assertEqual(value, "top_secret")
+        self.assertEqual(key, "my_secret")
+        self.assertFalse(is_complex)
+
+    @patch.object(
+        AWSParamStoreAppSource, "_json_contents", new_callable=PropertyMock
+    )
+    def test_get_field_value_failure(self, mock_json_contents: MagicMock):
+        """Tests that field value is not retrieved successfully"""
+
+        mock_json_contents.return_value = {}
+        source = AWSParamStoreAppSource(
+            ExampleSettings, aws_param_store_name="example-store-name"
+        )
+        field = ExampleSettings.model_fields["my_secret"]
+
+        value, key, is_complex = source.get_field_value(field, "my_secret")
+        self.assertIsNone(value)
+        self.assertEqual(key, "my_secret")
+        self.assertFalse(is_complex)
+
+
+class TestParameterStoreAppBaseSettings(unittest.TestCase):
+    """Test ParameterStoreBaseSettings class"""
+
+    def test_settings_customise_sources_with_param_store(self):
+        """Tests that sources are customised correctly"""
+        init = MagicMock()
+        env = MagicMock()
+        dotenv = MagicMock()
+        secret = MagicMock()
+        sources = ParameterStoreAppBaseSettings.settings_customise_sources(
+            settings_cls=ExampleSettings,
+            init_settings=init,
+            env_settings=env,
+            dotenv_settings=dotenv,
+            file_secret_settings=secret,
+        )
+        self.assertIsInstance(sources[1], AWSParamStoreAppSource)
+
+    def test_settings_customise_sources_without_param_store(self):
+        """Tests that sources are customised correctly"""
+
+        class NoParamSettings(ParameterStoreAppBaseSettings):
+            """Example settings class for testing no param store"""
+
+            model_config = {}
+
+        init = MagicMock()
+        env = MagicMock()
+        dotenv = MagicMock()
+        secret = MagicMock()
+
+        sources = NoParamSettings.settings_customise_sources(
+            NoParamSettings, init, env, dotenv, secret
+        )
+        self.assertEqual(sources[0], init)
+        self.assertEqual(len(sources), 4)
+
+
+if __name__ == "__main__":
+    unittest.main()