Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/whisller/ssmenv
SSMEnv allows you to read parameters from AWS Parameter Store and operate on results as on dictionary.
https://github.com/whisller/ssmenv
aws boto boto3 docker docker-compose environment environment-variables lambda parameter-store python ssm
Last synced: about 2 months ago
JSON representation
SSMEnv allows you to read parameters from AWS Parameter Store and operate on results as on dictionary.
- Host: GitHub
- URL: https://github.com/whisller/ssmenv
- Owner: whisller
- License: mit
- Archived: true
- Created: 2018-07-04T13:13:42.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-12-26T21:09:27.000Z (almost 4 years ago)
- Last Synced: 2024-09-24T18:32:38.388Z (about 2 months ago)
- Topics: aws, boto, boto3, docker, docker-compose, environment, environment-variables, lambda, parameter-store, python, ssm
- Language: Python
- Homepage:
- Size: 79.1 KB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SSMEnv
---
| master | coverage | PyPI | Python | Licence |
| --- | --- | --- | --- | --- |
| [](https://travis-ci.org/whisller/ssmenv) | [](https://coveralls.io/github/whisller/ssmenv?branch=develop) | [](https://pypi.org/project/ssmenv/) |  |  |
---
# This is readonly repository.
## Have a look at [aws-lambda-powertools-python](https://github.com/awslabs/aws-lambda-powertools-python)
SSMEnv allows you to read parameters from [AWS Parameter Store](https://docs.aws.amazon.com/systems-manager/latest/userguide/systems-manager-paramstore.html) and operate on results as on dictionary.
## Installation
Only requirement is to have `boto3` installed.
```bash
pip install ssmenv
```
## Reading parameters
Let's assume we have two parameters `token` and `url` under `/service/my-service` namespace.
Reading both parameters is as simple as initialising class object.
```python
from ssmenv import SSMEnv
params = SSMEnv("/service/my-service")
```
Done! Now we can access `/service/my-service/token` and `/service/my-service/url` in `params` variable!
Now `params` can be accesses as python `dict` type.
## Interacting with `SSMEnv` instance
As you know by now, instance of `SSMEnv` can be accessed as any `dict` in python which means you can do things like:
```python
from ssmenv import SSMEnv
params = SSMEnv("/service/my-service")
# 1. Access value directly
token = params["SERVICE_MY_SERVICE_TOKEN"]
# 2. Get list of all loaded parameter's names
list(params.keys())
# 3. Get list of all loaded parameter's values
list(params.values())
# and so on...
```
## Fetching multiple namespaces at once
In real world most often you will access parameters from different namespaces, you can easily do that with `SSMEnv`
by passing `tuple`
```python
from ssmenv import SSMEnv
params = SSMEnv("/service/my-service", "/resource/mysql")
```
Now `params` will have all parameters from both `/service/my-service` and `/resource/mysql`.
## AWS Lambda decorator
If you use AWS lambda, you might find handy `ssmenv` decorator. It behaves same as if you would initialise `SSMEnv` by hand, but additionally it injects instance of `SSMEnv` into `context.params` attribute.
```python
from ssmenv import ssmenv
@ssmenv("/service/my-service")
def handler(event, context):
return context.params
```
## Populating `os.environ`
You can hide use of `SSMEnv` by using `os.environ` dict.
```python
import os
from ssmenv import SSMEnv
os.environ = {**os.environ, **SSMEnv("/service/my-service")}
```
## Removing common prefixes
Accessing your parameters through whole namespaces can sometimes be not convenient
especially if you have very long names.
Hence why you can use `prefixes` parameter, to make your code cleaner.
```python
from ssmenv import SSMEnv
params = SSMEnv("/service/my-service", prefixes=("/service/my-service",))
params["TOKEN"]
```
## Returning dict in case there is no AWS context
You might want to run your application without AWS, e.g. through docker on your local machine and mock parameters.
For that you can use `no_aws_default` attribute.
```python
import os
from ssmenv import SSMEnv
os.environ["SERVICE_MY_SERVICE_TOKEN"] = "mocked-token" # that might be set in docker-compose
params = SSMEnv("/service/my-service", no_aws_default=os.environ)
```
## Passing your own boto3 client
You can pass your own boto3 client as well.
```python
import boto3
from ssmenv import SSMEnv
ssm_client = boto3.client("ssm")
params = SSMEnv("/service/my-service", ssm_client=ssm_client)
```