Skip to content

Commit 7f9d2f2

Browse files
authored
Update README.md (#16)
Added improved documentation on testing process
1 parent 8261815 commit 7f9d2f2

1 file changed

Lines changed: 19 additions & 2 deletions

File tree

README.md

Lines changed: 19 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,12 +49,20 @@ First, clone the repo locally and `cd` into the directory.
4949

5050
```sh
5151
git clone https://github.com/factset/analyticsapi-engines-python-sdk.git
52-
cd tests
5352
```
5453

55-
Next, install dependencies.
54+
Then, to make local package in `auto-generated-sdk` accessible to the tests, you have to build and register them in pip
5655

5756
```sh
57+
cd auto-generated-sdk/
58+
python setup.py sdist
59+
pip install .
60+
```
61+
62+
Next, install dependencies that the tests directory needs.
63+
64+
```sh
65+
cd tests/
5866
pip install -r requirements.txt
5967
```
6068

@@ -71,6 +79,15 @@ Run the tests with below command.
7179
python -m test
7280
```
7381

82+
**note when checking out different branches, you will have to re-install the auto-generated-sdk directory before running tests again
83+
```sh
84+
cd auto-generated-sdk/
85+
pip list # to view what version of fds.analyticsapi.engines is installed
86+
pip uninstall fds.analyticsapi.engines <version>
87+
python setup.py sdist
88+
pip install .
89+
```
90+
7491
## Contributing
7592

7693
* Files in [auto-generated-sdk](auto-generated-sdk) directory are auto-generated and should not be manually edited here. Refer [Analytics API Engines SDK Generator](https://github.com/factset/analyticsapi-engines-sdk-generator) for instructions on how to modify these files.

0 commit comments

Comments
 (0)