From e73acdcedf66e8d7c9e8519b19dd233ee177abb4 Mon Sep 17 00:00:00 2001 From: ZanSara Date: Mon, 29 Jan 2024 15:12:37 +0100 Subject: [PATCH] readme --- integrations/amazon_sagemaker/README.md | 31 ++++++++++++++++++++----- 1 file changed, 25 insertions(+), 6 deletions(-) diff --git a/integrations/amazon_sagemaker/README.md b/integrations/amazon_sagemaker/README.md index e240c11ee..1ea01871d 100644 --- a/integrations/amazon_sagemaker/README.md +++ b/integrations/amazon_sagemaker/README.md @@ -8,7 +8,7 @@ **Table of Contents** - [Installation](#installation) -- [Testing](#testing) +- [Contributing](#contributing) - [License](#license) ## Installation @@ -17,16 +17,35 @@ pip install amazon-sagemaker-haystack ``` -## Testing +## Contributing -To run the test suite locally, run: +`hatch` is the best way to interact with this project, to install it: +```sh +pip install hatch +``` -```console +With `hatch` installed, to run all the tests: +``` hatch run test ``` -You need to also export your AWS credentials for Sagemaker integration tests to run (`AWS_ACCESS_KEY_ID` and -`AWS_SECRET_SECRET_KEY`). If those are missing, the tests will be skipped. +> Note: You need to export your AWS credentials for Sagemaker integration tests to run (`AWS_ACCESS_KEY_ID` and +`AWS_SECRET_SECRET_KEY`). If those are missing, the integration tests will be skipped. + +To only run unit tests: +``` +hatch run test -m "not integration" +``` + +To only run integration tests: +``` +hatch run test -m "integration" +``` + +To run the linters `ruff` and `mypy`: +``` +hatch run lint:all +``` ## License