Skip to content

README.md - people should use exactly 3.13, update instructions about pyenv #62

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.

Sign up for GitHub

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

Open
wants to merge 1 commit into
base: live
Choose a base branch
from
Open

README.md - people should use exactly 3.13, update instructions about pyenv #62

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
16 changes: 13 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,13 +24,22 @@ Subsequent instructions assume that your current working directory is `os4d`, un

#### Create and activate a Python virtual environment

The following instructions assume you have [Python 3.10](https://www.python.org/downloads/) or newer installed on your machine.
The following instructions assume you have [Python 3.13](https://www.python.org/downloads/) installed on your machine, as we need to use the same version of python the docs are built with.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since the instructions now include installing Python 3.13, I think it's simpler to state it as a requirement, rather than an assumption followed by a 'need to' clause.

Suggested change
The following instructions assume you have [Python 3.13](https://www.python.org/downloads/) installed on your machine, as we need to use the same version of python the docs are built with.
The build requires [Python](https://www.python.org/downloads/) 3.13.


You can use either [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), `python3-venv` or a Python environment manager of your choice:
If you already have 3.13 you can use `python3-venv` or a Python environment manager of your choice.

If not we recommend pyenv.
Comment on lines +29 to +31
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
If you already have 3.13 you can use `python3-venv` or a Python environment manager of your choice.
If not we recommend pyenv.
If you already have Python 3.13 installed, you can create a virtual environment using [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv), `python3-venv`, or a Python environment manager of your choice.
If not, we recommend using `pyenv` to install Python 3.13 and `pyenv-virtualenv` to create a virtual environment.


##### pyenv

1. Install [pyenv](https://github.com/pyenv/pyenv) and the [pyenv-virtualenv](https://github.com/pyenv/pyenv-virtualenv) plugin. The [pyenv installer](https://github.com/pyenv/pyenv-installer) is recommended.
1. Set up Python 3.13 using pyenv:

```bash
pyenv install 3.13
pyenv local 3.13
```

Comment on lines +36 to +42
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't have pyenv on my machine any more, but I'm pretty sure that you can just do pyenv virtualenv 3.13 os4d at the next step, which makes the instructions the same regardless of whether the reader already has Python 3.13 installed or not.

1. Create a virtual environment:

```bash
Expand Down Expand Up @@ -188,4 +197,5 @@ Read the Docs automatically creates and builds [pull request previews](https://d

#### Credentials

You can find credentials for Read the Docs in the Open Data Services password database.
You can find credentials for Read the Docs in the Open Data Services password database.