Skip to content

Commit 240c0b6

Browse files
committed
updated dev workflow + pyproject.toml
1 parent ed53cd0 commit 240c0b6

2 files changed

Lines changed: 21 additions & 4 deletions

File tree

README.md

Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -665,9 +665,23 @@ mktxp is running as pid 36704
665665
```
666666

667667
## Installing Development version
668-
- Clone the repo, then run: `$ python setup.py develop`
669-
668+
- Clone the repo, create a virtual environment, and activate it:
669+
```bash
670+
$ python3 -m venv .venv
671+
$ source .venv/bin/activate
672+
```
673+
- Install the project in editable mode:
674+
```bash
675+
$ pip install -e .
676+
```
670677

671678
**Running Tests**
672-
- To run the test suite, first install the development dependencies: `pip install -e .[test]`
673-
- Then run the tests using `tox`: `$ tox`
679+
- To run the test suite, first ensure you have installed the development dependencies:
680+
```bash
681+
$ pip install -e ".[test]"
682+
```
683+
- Then run the tests using `pytest`:
684+
```bash
685+
$ pytest -v --tb=short
686+
```
687+
*(Note: If you have `tox` installed, you can still run `$ tox` for multi-environment testing)*

pyproject.toml

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
[build-system]
2+
requires = ["setuptools>=61.0"]
3+
build-backend = "setuptools.build_meta"

0 commit comments

Comments
 (0)