Skip to content

Commit dd3819c

Browse files
Merge pull request #13 from VH-Lab/update-readme-2286328433372700681
Update README installation and test instructions
2 parents d9ce969 + 6618b66 commit dd3819c

2 files changed

Lines changed: 34 additions & 3 deletions

File tree

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
name: Python package
2+
3+
on:
4+
push:
5+
branches: [ "main" ]
6+
pull_request:
7+
branches: [ "main" ]
8+
9+
jobs:
10+
build:
11+
12+
runs-on: ubuntu-latest
13+
strategy:
14+
fail-fast: false
15+
matrix:
16+
python-version: ["3.10", "3.11"]
17+
18+
steps:
19+
- uses: actions/checkout@v4
20+
- name: Set up Python ${{ matrix.python-version }}
21+
uses: actions/setup-python@v3
22+
with:
23+
python-version: ${{ matrix.python-version }}
24+
- name: Install dependencies
25+
run: |
26+
python -m pip install --upgrade pip
27+
pip install -e ".[dev]"
28+
pip install pytest
29+
- name: Test with pytest
30+
run: |
31+
pytest

README.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -34,17 +34,17 @@ The `did` library provides a framework for managing and querying data that is or
3434
source venv/bin/activate # On Windows, use `venv\Scripts\activate`
3535
```
3636

37-
3. **Install the required dependencies:**
37+
3. **Install the package and dependencies:**
3838
```bash
39-
pip install -r requirements.txt
39+
pip install -e ".[dev]"
4040
```
4141

4242
### Running the Tests
4343

4444
To run the test suite, use the following command:
4545

4646
```bash
47-
find . -name "test_*.py" -exec python -m unittest {} +
47+
python -m unittest discover tests
4848
```
4949

5050
This will discover and run all the tests in the `tests` directory.

0 commit comments

Comments
 (0)