Skip to content

Commit b1a3fd1

Browse files
authored
Update development instructions (#412)
1 parent 146954c commit b1a3fd1

1 file changed

Lines changed: 12 additions & 7 deletions

File tree

README.md

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -59,24 +59,29 @@ It is recommended to use `venv` to create a clean environment to build/test Ion
5959
$ python3 -m venv ./venv
6060
...
6161
$ . venv/bin/activate
62-
$ pip install -U pip
63-
$ pip install -U 'setuptools<71.0.0'
64-
$ pip install -r requirements.txt
65-
$ pip install -e .
62+
$ python -m pip install build
63+
$ python -m pip install '.[test]'
6664
```
6765

68-
You can also run the tests through `setup.py` or `py.test` directly.
66+
You can run the tests through `py.test` directly:
6967

7068
```
71-
$ python setup.py test
69+
$ py.test --ignore tests/test_benchmark_cli.py --ignore tests/test_benchmark_spec.py
7270
```
7371

72+
This recipe skips the benchmark tests because they require additional dependencies:
73+
74+
When in doubt, look at [`.github/workflows/main.yml`](.github/workflows/main.yml) to see CI setup
75+
and learn how to build/test the project.
76+
See also [ion-python#379](https://github.com/amazon-ion/ion-python/pull/379) for a writeup of our
77+
adoption of pyproject.toml.
78+
7479
### Tox Setup
7580
In order to verify that all platforms we support work with Ion Python, we use a combination
7681
of [tox](http://tox.readthedocs.io/en/latest/) with [pyenv](https://github.com/yyuu/pyenv).
7782

7883
We recommend that you use tox within a virtual environment to isolate from whatever is in the system
79-
installed Python (`requirements.txt` installs `tox`).
84+
installed Python.
8085

8186
Install relevant versions of Python:
8287

0 commit comments

Comments
 (0)