Skip to content

Commit bd3f57b

Browse files
authored
Merge pull request #3004 from opentensor/feat/thewhaleking/note-for-macos-install
Adds note for installing on macOS
2 parents 12848aa + 58a8161 commit bd3f57b

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,14 @@ python3 -m pip install --upgrade bittensor
9494

9595
## Install on macOS and Linux
9696

97+
### Note for macOS users
98+
The macOS preinstalled CPython installation is compiled with LibreSSL instead of OpenSSL. There are a number
99+
of issues with LibreSSL, and as such is not fully supported by the libraries used by bittensor. Thus we highly recommend, if
100+
you are using a Mac, to first install Python from [Homebrew](https://brew.sh/). Additionally, the Rust FFI bindings
101+
[if installing from precompiled wheels (default)] require the Homebrew-installed OpenSSL pacakge. If you choose to use
102+
the preinstalled Python version from macOS, things may not work completely.
103+
104+
### Installation
97105
You can install Bittensor SDK on your local machine in either of the following ways. **Make sure you verify your installation after you install**:
98106
- [Install using a Bash command](#install-using-a-bash-command).
99107
- [Install using `pip3 install`](#install-using-pip3-install)
@@ -158,6 +166,13 @@ You can install using any of the below options:
158166
1. Install `cubit` first. See the [Install](https://github.com/opentensor/cubit?tab=readme-ov-file#install) section. **Only Python 3.9 and 3.10 versions are supported**.
159167
2. Then install SDK with `pip install bittensor`.
160168

169+
170+
### Troubleshooting
171+
#### SSL: CERTIFICATE_VERIFY_FAILED
172+
173+
If you are encountering a `[SSL: CERTIFICATE_VERIFY_FAILED] certificate verify failed: unable to get local issuer certificate`
174+
error, use the command `python -m bittensor certifi` which will update your local SSL certificates.
175+
161176
---
162177

163178
## Install on Windows

0 commit comments

Comments
 (0)