Skip to content

Update development instructions #412

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
May 21, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -59,24 +59,29 @@ It is recommended to use `venv` to create a clean environment to build/test Ion
$ python3 -m venv ./venv
...
$ . venv/bin/activate
$ pip install -U pip
$ pip install -U 'setuptools<71.0.0'
$ pip install -r requirements.txt
$ pip install -e .
$ python -m pip install build
$ python -m pip install '.[test]'
```

You can also run the tests through `setup.py` or `py.test` directly.
You can run the tests through `py.test` directly:

```
$ python setup.py test
$ py.test --ignore tests/test_benchmark_cli.py --ignore tests/test_benchmark_spec.py
```

This recipe skips the benchmark tests because they require additional dependencies:

When in doubt, look at [`.github/workflows/main.yml`](.github/workflows/main.yml) to see CI setup
and learn how to build/test the project.
See also [ion-python#379](https://github.com/amazon-ion/ion-python/pull/379) for a writeup of our
adoption of pyproject.toml.

### Tox Setup
In order to verify that all platforms we support work with Ion Python, we use a combination
of [tox](http://tox.readthedocs.io/en/latest/) with [pyenv](https://github.com/yyuu/pyenv).

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

Install relevant versions of Python:

Expand Down