From 5e078c429a42f57016b314e9b6d761de3447799b Mon Sep 17 00:00:00 2001 From: ff137 Date: Thu, 4 Apr 2024 12:37:18 +0200 Subject: [PATCH] :art: fix markdown warnings --- generator/README.md | 4 +++- tests/README.md | 6 +++--- 2 files changed, 6 insertions(+), 4 deletions(-) diff --git a/generator/README.md b/generator/README.md index 1963ce53f..56d697e7d 100644 --- a/generator/README.md +++ b/generator/README.md @@ -3,6 +3,7 @@ Currently to generate the client you need to use the DIDx fork of OpenAPI generator and build the JAR yourself. ## Prerequisites + ```sh # Clone projects git clone https://github.com/didx-xyz/aries-cloudcontroller-python @@ -17,9 +18,10 @@ mvn -B --no-snapshot-updates clean package -DskipTests=true -Dmaven.javadoc.skip ``` ## Generate the CloudController client + ```sh cd aries-cloudcontroller-python -pip install -r requirements.txt -r requirements.dev.txt +pip install -r requirements.txt -r requirements.dev.txt --upgrade ./generator/scripts/generate-client.sh 0.9.0 # Or other ACA-Py version ``` diff --git a/tests/README.md b/tests/README.md index e3a74aa0f..18dd11b6b 100644 --- a/tests/README.md +++ b/tests/README.md @@ -1,7 +1,7 @@ -### Running tests locally +# Running tests locally -In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project. +In order to run the tests locally, e.g. for development, make sure you have installed the requirements by running `pip install -r requirements.txt` in the root of the project. You can now run all tests py running `pytest` in the root of the project. in order to run specific tests you can specifying the test file to run, e.g. `pytest tests/path/to/your/testfile.py`. You can also run individual tests only using the `-k` flag of pytest `pytest tests/path/to/your/testfile.py -k 'test_your_whatever'` where `test_your_whatever` is the name of the test definition. For more information, please, refer to the [pytest docs](https://docs.pytest.org/en/). -It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails. \ No newline at end of file +It is recommended to run the tests locally (and to add tests to your chnages and code additions). Tests will automatically run when trying to merge into or push to master. The merge or push will be rejected if any test fails.