Skip to content

Commit

Permalink
docs: update README to include note for issue in Python 3.10
Browse files Browse the repository at this point in the history
  • Loading branch information
MRichards99 committed Mar 24, 2022
1 parent caf1861 commit 72181f6
Showing 1 changed file with 6 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -386,6 +386,10 @@ poetry remove python-icat
poetry add python-icat=0.21.0
```

If using Python 3.10, please use Payara 5 on the ICAT stack which the API is being
pointed at. There is a known issue when making HTTPS connections to Payara (via Python
ICAT).


## DataGateway API Authentication
Each request requires a valid session ID to be provided in the Authorization header.
Expand Down Expand Up @@ -427,8 +431,8 @@ your test environment, using `config.json.example` as a reference. The tests req
connection to an instance of ICAT, so set the rest of the config as needed.

By default, this will execute the repo's tests in
Python 3.6, 3.7 and 3.8. For most cases, running the tests in a single Python version
will be sufficient:
Python 3.6, 3.7, 3.8, 3.9 and 3.10. For most cases, running the tests in a single Python
version will be sufficient:

```bash
nox -p 3.6 -s tests
Expand Down

0 comments on commit 72181f6

Please sign in to comment.