Skip to content

Commit

Permalink
Add minor details about Central version
Browse files Browse the repository at this point in the history
  • Loading branch information
lognaturel committed May 2, 2024
1 parent 62f49e3 commit 58c082b
Showing 1 changed file with 3 additions and 2 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,9 +7,9 @@ This library aims to make common data analysis and workflow automation tasks as

## Install

The currently supported Python version is 3.12. We recommend using [`pyenv`](https://github.com/pyenv/pyenv) to manage multiple versions of Python.
The currently supported Python version for `pyodk` is 3.12. If this is different from the version you use for other projects, consider using [`pyenv`](https://github.com/pyenv/pyenv) to manage multiple versions of Python.

The currently supported Central version is v2024.1.0. Newer or older Central versions will likely work too, but convenience (non-HTTP) methods assume this version.
The currently supported Central version is v2024.1.0. Newer or older Central versions will likely work too, but convenience (non-HTTP) methods assume this version. If you see a 404 error or another server error, please verify the version of your Central server.

### From pip

Expand Down Expand Up @@ -199,5 +199,6 @@ For interactive testing, debugging, or sanity checking workflows, end-to-end tes
1. Draft a new GitHub release with the list of merged PRs.
1. Check out a release branch from latest upstream master.
1. Update `pyproject.toml` and `pyodk/__version__.py` with the new release version number.
1. Update the Central version in the README to reflect the version we test against.
1. Commit, push the branch, and initiate a pull request. Wait for tests to pass, then merge the PR.
1. Tag the release and it will automatically be published (see `release.yml` actions file).

0 comments on commit 58c082b

Please sign in to comment.