Skip to content

Commit 524abfb

Browse files
committed
Update documentation instructions (#377)
1 parent 4abef46 commit 524abfb

File tree

1 file changed

+8
-34
lines changed
  • docs/user_guides/client_installation

1 file changed

+8
-34
lines changed

docs/user_guides/client_installation/index.md

+8-34
Original file line numberDiff line numberDiff line change
@@ -9,68 +9,42 @@ The Hopsworks client library is required to connect to the Hopsworks Feature Sto
99
!!! note "Virtual environment"
1010
It is recommended to use a virtual python environment instead of the system environment used by your operating system, in order to avoid any side effects regarding interfering dependencies.
1111

12-
```
12+
```bash
1313
pip install hopsworks
1414
```
1515
Supported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 ([PyPI ↗](https://pypi.org/project/hopsworks/))
1616

1717
!!! attention "OSX Installation"
18-
19-
On OSX systems you might need to install librdkafka manually before installing hopsworks. You can verify if you have installed it previously using `brew info librdkafka`. Hopsworks requires `librdkafka` version to be lower than 2.0.0. If it is not installed yet, you can do so using `brew install`, however, you always need to set the `C_INCLUDE_PATH` and `LIBRARY_PATH`.
20-
21-
If not installed yet, install librdkafka:
22-
```
23-
curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/f7d0f40bbc4075177ecf16812fd95951a723a996/Formula/librdkafka.rb
24-
brew install --build-from-source librdkafka.rb
25-
```
26-
If it is already installed, set the environment variables and proceed with installing the hopsworks client library:
27-
```
28-
export C_INCLUDE_PATH=$(brew --prefix)/include
29-
export LIBRARY_PATH=$(brew --prefix)/lib
30-
pip install hopsworks
31-
```
18+
Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install `librdkafka` manually. Checkout the documentation for the specific version you are installing.
3219

3320
!!! attention "Windows/Conda Installation"
3421

3522
On Windows systems you might need to install twofish manually before installing hopsworks, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
3623

37-
```
24+
```bash
3825
conda install twofish
39-
setx CONDA_DLL_SEARCH_MODIFICATION_ENABLE 1
4026
pip install hopsworks
4127
```
4228

4329
## Feature Store only
4430
To only install the Hopsworks Feature Store client library, execute the following command:
4531

46-
```
32+
```bash
4733
pip install hsfs[python]
34+
# or if using zsh
35+
pip install 'hsfs[python]'
4836
```
4937
Supported versions of Python: 3.8, 3.9, 3.10, 3.11, 3.12 ([PyPI ↗](https://pypi.org/project/hsfs/))
5038

5139
!!! attention "OSX Installation"
52-
53-
On OSX systems you might need to install librdkafka manually before installing hopsworks. You can verify if you have installed it previously using `brew info librdkafka`. Hopsworks requires `librdkafka` version to be lower than 2.0.0. If it is not installed yet, you can do so using `brew install`, however, you always need to set the `C_INCLUDE_PATH` and `LIBRARY_PATH`.
54-
55-
If not installed yet, install librdkafka:
56-
```
57-
curl -O https://raw.githubusercontent.com/Homebrew/homebrew-core/f7d0f40bbc4075177ecf16812fd95951a723a996/Formula/librdkafka.rb
58-
brew install --build-from-source librdkafka.rb
59-
```
60-
If it is already installed, set the environment variables and proceed with installing the hopsworks client library:
61-
```
62-
export C_INCLUDE_PATH=$(brew --prefix)/include
63-
export LIBRARY_PATH=$(brew --prefix)/lib
64-
pip install hsfs[python]
65-
```
40+
Hopsworks latest version should work on OSX systems without any additional requirements. However if installing an older version of the Hopsworks SDK you might need to install `librdkafka` manually. Checkout the documentation for the specific version you are installing.
6641

6742
!!! attention "Windows/Conda Installation"
6843

6944
On Windows systems you might need to install twofish manually before installing hsfs, if you don't have the Microsoft Visual C++ Build Tools installed. In that case, it is recommended to use a conda environment and run the following commands:
7045

71-
```
46+
```bash
7247
conda install twofish
73-
setx CONDA_DLL_SEARCH_MODIFICATION_ENABLE 1
7448
pip install hsfs[python]
7549
```
7650

0 commit comments

Comments
 (0)