Skip to content

Commit

Permalink
update installation notes
Browse files Browse the repository at this point in the history
  • Loading branch information
MaxHalford committed Oct 5, 2023
1 parent a6e57f1 commit 089e570
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 13 deletions.
7 changes: 5 additions & 2 deletions .github/workflows/pypi.yml
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,9 @@ jobs:
- os: macos-latest
arch: alt
alt_arch_name: arm64
- os: ubuntu-latest
platform: linux
alt_arch_name: aarch64
exclude:
- os: windows-latest
arch: alt
Expand Down Expand Up @@ -52,14 +55,14 @@ jobs:

- name: Set up QEMU
if: matrix.os == 'ubuntu-latest'
uses: docker/setup-qemu-action@v1
uses: docker/setup-qemu-action@v3
with:
platforms: all

- name: Build wheels
uses: pypa/[email protected]
env:
CIBW_BUILD: "cp38-* cp39-* cp310-* cp311-*"
CIBW_BUILD: "cp38-* cp39-* cp310-* cp311-* cp312-*"
CIBW_BEFORE_BUILD: >
pip install setuptools-rust cython &&
rustup default nightly &&
Expand Down
2 changes: 2 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -210,3 +210,5 @@ END
brew update && brew install gh
gh release create $RIVER_VERSION --notes $RELEASE_NOTES
```

11. Pyodide needs to be told there is a new release. This can done by updating [`packages/river`](https://github.com/online-ml/pyodide/tree/main/packages/river) in [online-ml/pyodide](https://github.com/online-ml/pyodide)
9 changes: 3 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -109,19 +109,16 @@ River is intended to work with **Python 3.8 and above**. Installation can be don
pip install river
```

There are [wheels available](https://pypi.org/project/river/#files) for Linux, MacOS, and Windows, which means that you most probably won't have to build River from source.
There are [wheels available](https://pypi.org/project/river/#files) for Linux, MacOS, and Windows. This means you most probably won't have to build River from source.

You can install the latest development version from GitHub as so:

```sh
pip install git+https://github.com/online-ml/river --upgrade
pip install git+ssh://[email protected]/online-ml/river.git --upgrade # using SSH
```

Or, through SSH:

```sh
pip install git+ssh://[email protected]/online-ml/river.git --upgrade
```
This method requires having Cython and Rust installed on your machine.

## 🔮 Features

Expand Down
7 changes: 2 additions & 5 deletions docs/introduction/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,12 +10,9 @@ You can install the latest development version from GitHub, as so:

```sh
pip install git+https://github.com/online-ml/river --upgrade
pip install git+ssh://[email protected]/online-ml/river.git --upgrade # using SSH
```

Or, through SSH:

```sh
pip install git+ssh://[email protected]/online-ml/river.git --upgrade
```
This method requires having Cython and Rust installed on your machine.

Feel welcome to [open an issue on GitHub](https://github.com/online-ml/river/issues/new) if you are having any trouble.

0 comments on commit 089e570

Please sign in to comment.