Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs(feature-flags): create concrete documentation #594

Merged
merged 44 commits into from
Aug 10, 2021
Merged
Show file tree
Hide file tree
Changes from 39 commits
Commits
Show all changes
44 commits
Select commit Hold shift + click to select a range
faec4ce
feat(logger): add option to clear state per invocation
heitorlessa Jun 8, 2021
c7bd7fb
Merge branch 'develop' of https://github.com/awslabs/aws-lambda-power…
heitorlessa Jun 8, 2021
9019f30
refactor: rename to remove_custom_keys
heitorlessa Jun 8, 2021
d1b7c22
refactor: rename to clear_state
heitorlessa Jun 8, 2021
5a3aa25
Merge branch 'develop' of https://github.com/awslabs/aws-lambda-power…
heitorlessa Jun 8, 2021
a691676
docs: fix anchor
heitorlessa Jun 8, 2021
745ac9f
Merge branch 'develop' of github.com:awslabs/aws-lambda-powertools-py…
Aug 5, 2021
7a66dab
docs(feature-flags): add basic docs
Aug 6, 2021
b34643d
docs: fix tip rendering banner
heitorlessa Aug 6, 2021
e5a24fd
docs(feature-flags): refactored basic section structure
Aug 6, 2021
20cce82
Merge branch 'docs/feature-toggle-examples' of github.com:am29d/aws-l…
Aug 6, 2021
527921e
docs(feature-flags): refactored examples for getting started
Aug 6, 2021
85d2fc5
add external articles links
Aug 10, 2021
84f8bfd
add CDK example for appconfig
Aug 10, 2021
0250511
add envelope
Aug 10, 2021
5385b4f
add appconfig store provider
Aug 10, 2021
d246f67
add testing section
Aug 10, 2021
7c5a881
docs: add feat flags utility
heitorlessa Aug 10, 2021
0f6a230
docs: fix typo
heitorlessa Aug 10, 2021
4a159ec
docs: complete adjusting in-memory cache section
heitorlessa Aug 10, 2021
1c72a06
docs: complete envelope section
heitorlessa Aug 10, 2021
186293f
fix(feature flags): set default cache to 5 as documented
heitorlessa Aug 10, 2021
8a3ee9d
docs: complete built-in stores section
heitorlessa Aug 10, 2021
b8ee65f
docs: complete testing your code section
heitorlessa Aug 10, 2021
4cb287b
fix: typo
heitorlessa Aug 10, 2021
1195f7c
fix: test docs identation
heitorlessa Aug 10, 2021
48abcba
fix: missing import on test
heitorlessa Aug 10, 2021
350abac
fix: remove namespace warning after testing hypothesis
heitorlessa Aug 10, 2021
8466cf7
remove todo comments
Aug 10, 2021
ee69581
Merge branch 'docs/feature-toggle-examples' of github.com:am29d/aws-l…
Aug 10, 2021
b5e837e
fix: tip banner rendering
heitorlessa Aug 10, 2021
7ff670d
Merge branch 'docs/feature-toggle-examples' of https://github.com/am2…
heitorlessa Aug 10, 2021
642d0eb
docs: improve terminology section
heitorlessa Aug 10, 2021
1628b2a
fix: frontmatter
heitorlessa Aug 10, 2021
f1e98ca
docs: add note about Beta
heitorlessa Aug 10, 2021
5567f6e
refactor(store): use max_age over cache_seconds for consistency
heitorlessa Aug 10, 2021
02c9169
docs: complete key features section
heitorlessa Aug 10, 2021
58258cd
docs: minor change on IAM permissions
heitorlessa Aug 10, 2021
1dabcd9
docs: complete required resources section
heitorlessa Aug 10, 2021
dcbe08b
Merge branch 'develop' into docs/feature-toggle-examples
heitorlessa Aug 10, 2021
eb72d96
Merge branch 'develop' of https://github.com/awslabs/aws-lambda-power…
heitorlessa Aug 10, 2021
fec2a60
docs: complete single and all features section
heitorlessa Aug 10, 2021
802aab3
docs: add rule engine flowchart; move schema to advanced
heitorlessa Aug 10, 2021
203664c
docs: complete schema section
heitorlessa Aug 10, 2021
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ A suite of Python utilities for AWS Lambda functions to ease adopting best pract
* **[Event source data classes](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/data_classes/)** - Data classes describing the schema of common Lambda event triggers
* **[Parser](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/parser/)** - Data parsing and deep validation using Pydantic
* **[Idempotency](https://awslabs.github.io/aws-lambda-powertools-python/latest/utilities/idempotency/)** - Convert your Lambda functions into idempotent operations which are safe to retry
* **[Feature Flags](./utilities/feature_flags.md)** - A simple rule engine to evaluate when one or multiple features should be enabled depending on the input

### Installation

Expand Down
8 changes: 4 additions & 4 deletions aws_lambda_powertools/utilities/feature_flags/appconfig.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ def __init__(
environment: str,
application: str,
name: str,
cache_seconds: int,
max_age: int = 5,
sdk_config: Optional[Config] = None,
envelope: Optional[str] = "",
jmespath_options: Optional[Dict] = None,
Expand All @@ -36,8 +36,8 @@ def __init__(
AppConfig application name, e.g. 'powertools'
name: str
AppConfig configuration name e.g. `my_conf`
cache_seconds: int
cache expiration time, how often to call AppConfig to fetch latest configuration
max_age: int
cache expiration time in seconds, or how often to call AppConfig to fetch latest configuration
sdk_config: Optional[Config]
Botocore Config object to pass during client initialization
envelope : Optional[str]
Expand All @@ -49,7 +49,7 @@ def __init__(
self.environment = environment
self.application = application
self.name = name
self.cache_seconds = cache_seconds
self.cache_seconds = max_age
self.config = sdk_config
self.envelope = envelope
self.jmespath_options = jmespath_options
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ def __init__(self, store: StoreProvider):
environment="test",
application="powertools",
name="test_conf_name",
cache_seconds=300,
max_age=300,
envelope="features"
)

Expand Down
1 change: 1 addition & 0 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@ aws serverlessrepo list-application-versions \
[Event source data classes](./utilities/data_classes.md) | Data classes describing the schema of common Lambda event triggers
[Parser](./utilities/parser.md) | Data parsing and deep validation using Pydantic
[Idempotency](./utilities/idempotency.md) | Idempotent Lambda handler
[Feature Flags](./utilities/feature_flags.md) | A simple rule engine to evaluate when one or multiple features should be enabled depending on the input

## Environment variables

Expand Down
Loading