Skip to content

Commit

Permalink
Update README (#7)
Browse files Browse the repository at this point in the history
* Update README

* Bump version
  • Loading branch information
Luca Valentini authored Aug 27, 2019
1 parent 330df6a commit 5cd2851
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 8 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,15 +21,15 @@ your own services being rate-limited in turn.

## Install
```bash
pip install aws-ssm
pip install python-aws-ssm
```

## Examples

#### Basic Usage

```python
from aws_ssm.parameters import ParameterStore
from python_aws_ssm.parameters import ParameterStore

# Assuming you have the parameters in the following format:
# my-service/dev/param-1 -> with value `a`
Expand All @@ -45,7 +45,7 @@ value = parameters.get("param-1")
#### Recursive and nested options

```python
from aws_ssm.parameters import ParameterStore
from python_aws_ssm.parameters import ParameterStore

# Assuming you have the parameters in the following format:
# my-service/dev/param-1 -> with value `a`
Expand All @@ -63,7 +63,7 @@ dev_parameters = parameters.get("dev")
#### Get parameters by name

```python
from aws_ssm.parameters import ParameterStore
from python_aws_ssm.parameters import ParameterStore

# Assuming you have the parameters in the following format:
# my-service/dev/param-1 -> with value `a`
Expand All @@ -81,7 +81,7 @@ dev_parameters = parameters.get("/common/dev/param-2")
#### With custom client

```python
from aws_ssm.parameters import ParameterStore
from python_aws_ssm.parameters import ParameterStore
import boto3

# Initialise an SSM client to specify the source of the credentials.
Expand Down
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[tool.poetry]
name = "python-aws-ssm"
version = "0.1.1"
version = "0.1.2"
description = "Python package that interfaces with AWS System Manager"
authors = ["Luca Valentini <luca@paddle.com>", "Maarten Jacobs <maarten@paddle.com>"]
# New attributes
Expand Down
2 changes: 1 addition & 1 deletion python_aws_ssm/__init__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "0.1.1"
__version__ = "0.1.2"
2 changes: 1 addition & 1 deletion tests/test_python_aws_ssm.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@


def test_version():
assert __version__ == "0.1.1"
assert __version__ == "0.1.2"


class TestGetParameters(TestCase):
Expand Down

0 comments on commit 5cd2851

Please sign in to comment.