Skip to content

Commit

Permalink
🎨 fix markdown warnings
Browse files Browse the repository at this point in the history
  • Loading branch information
ff137 committed Apr 4, 2024
1 parent 26e6f5c commit 5e078c4
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 4 deletions.
4 changes: 3 additions & 1 deletion generator/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
```
6 changes: 3 additions & 3 deletions tests/README.md
Original file line number Diff line number Diff line change
@@ -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.
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.

0 comments on commit 5e078c4

Please sign in to comment.