Skip to content

Add configuration options to README #8

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.

Sign up for GitHub

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

Open
wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Add configuration options to README #8

Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
a4868f0
Skip specific snapshot paths when running tests against non-local ver…
RobertLucian Feb 24, 2025
6dea3d3
Update README.md
RobertLucian Feb 25, 2025
9501f38
Remove TEST_FORCE_SNAPSHOT_SKIP_VERIFY
RobertLucian Feb 25, 2025
6ce1cea
Format
RobertLucian Feb 25, 2025
c4f0012
Add effects of configuration variables
simonrw Apr 29, 2025
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
13 changes: 11 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,19 @@ This project is in a very early stage and will be both restructured and renamed.

## Quickstart

to install the python and other developer requirements into a venv run:
To install the python and other developer requirements into a venv run:

make install

### Configuration options

There's a few env vars that can be used with this project:

* `TEST_TARGET`: Set to `AWS_CLOUD` to use an externally-deployed instance when running tests.
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

note: In the future this shouldn't be part of the library. For now it's ok to include it in the README as it's still included 👍

* `SNAPSHOT_LEGACY_REPORT`: By default set to `0`. Can be set to `1`. This enables the legacy reporting output style.
* `SNAPSHOT_UDPATE`: By default set to `0`. Can be set to `1`. This enables updating the snapshot file rather than comparing with its contents.
* `SNAPSHOT_RAW`: By default set to `0`. Can be set to `1`. This outputs an additional snapshot file which contains the untransformed values.

## Format code

We use black and isort as code style tools.
Expand All @@ -23,4 +32,4 @@ To execute them, run:

To build a wheel and source distribution, simply run

make dist
make dist