Skip to content
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

Update macOS installation instructions to block Python 3.12 #615

Merged
merged 1 commit into from
Oct 30, 2023
Merged

Update macOS installation instructions to block Python 3.12 #615

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
10 changes: 4 additions & 6 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ Installing this toolset using `pipx` makes the `se` command line executable avai

# Installation

The toolset requires Python >= 3.7.
The toolset requires Python >= 3.7 and < 3.12.

To install the toolset locally for development and debugging, see [Installation for toolset developers](#installation-for-toolset-developers).

Expand Down Expand Up @@ -66,9 +66,7 @@ sudo ln -s $HOME/.local/pipx/venvs/standardebooks/lib/python3.*/site-packages/se
sudo ln -s $HOME/.local/pipx/venvs/standardebooks/lib/python3.*/site-packages/se/completions/fish/se $HOME/.config/fish/completions/se.fish
```

## macOS users (up to macOS 12)

These instructions were tested on macOS 10.15 to 12, on Intel macs.
## macOS users

1. Install the [Homebrew package manager](https://brew.sh). Or, if you already have it installed, make sure it’s up to date:

Expand All @@ -80,12 +78,12 @@ These instructions were tested on macOS 10.15 to 12, on Intel macs.

```shell
# Install some pre-flight dependencies.
brew install cairo calibre git openjdk pipx python
brew install cairo calibre git openjdk pipx python@3.11
Copy link
Member

Choose a reason for hiding this comment

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

Will this stomp on some other globally-installed Python version?

Copy link
Member Author

Choose a reason for hiding this comment

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

No, Homebrew’s happy to install multiple different concurrent python versions.

pipx ensurepath
sudo ln -sfn $(brew --prefix)/opt/openjdk/libexec/openjdk.jdk /Library/Java/JavaVirtualMachines/openjdk.jdk

# Install the toolset.
pipx install standardebooks
pipx install --python python3.11 standardebooks

# Optional: Bash users who have set up bash-completion via brew can install tab completion.
ln -s $HOME/.local/pipx/venvs/standardebooks/lib/python3.*/site-packages/se/completions/bash/se $(brew --prefix)/etc/bash_completion.d/se
Expand Down