Skip to content

Commit 09e8134

Browse files
authored
Merge pull request PyDMD#541 from PyDMD/fixes-test-tutorials
Minor CI fixes and README improvements
2 parents 14ac6d3 + 5d49f19 commit 09e8134

File tree

3 files changed

+16
-6
lines changed

3 files changed

+16
-6
lines changed

.github/workflows/export_tutorials.yml

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -23,11 +23,8 @@ jobs:
2323

2424
- name: Install dependencies
2525
run: |
26-
python3 -m pip install --upgrade pip
27-
python3 -m pip install .[test]
28-
python3 -m pip install -e .
2926
# Dependencies for tutorials
30-
python3 -m pip install jupyter pandas ezyrb opencv-python ffmpeg-python black[jupyter]
27+
python3 -m pip install --upgrade pip .[tutorial] black[jupyter]
3128
3229
- uses: actions/cache@v2
3330
id: cache-segtrackv2

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -234,9 +234,15 @@ Do you want to join the team? Read the [Contributing guidelines](.github/CONTRIB
234234
Made with [contrib.rocks](https://contrib.rocks).
235235

236236
### Testing
237-
We use `pytest` to run our unit tests. You can run the whole test suite by using the following command in the base directory of the repository:
237+
We use `pytest` to run our unit tests. Use the following command to install the dependencies required to test a local clone of PyDMD (assuming
238+
the relative path of the repository to be `./PyDMD/`):
238239
```bash
239-
pytest
240+
python -m pip install PyDMD/[test]
241+
```
242+
243+
You can run the whole test suite by using the following command in the base directory of the repository:
244+
```bash
245+
python -m pytest
240246
```
241247

242248
## Funding

pyproject.toml

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,13 @@ test = [
4444
"pytest-mock",
4545
"ezyrb>=v1.2.1.post2205"
4646
]
47+
tutorial = [
48+
"jupyter",
49+
"pandas",
50+
"ezyrb",
51+
"opencv-python",
52+
"ffmpeg-python",
53+
]
4754
docs = [
4855
"sphinx>=1.4",
4956
"sphinx_rtd_theme"

0 commit comments

Comments
 (0)