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

docs: Remove outdated installation instructions and dependencies #888

Merged
merged 2 commits into from
Sep 6, 2024
Merged

docs: Remove outdated installation instructions and dependencies #888

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4260a70
docs: Remove outdated installation instructions and dependencies
sasa-tomic Sep 6, 2024
6a3fb3b
Update docs/contributing.md
sasa-tomic Sep 6, 2024
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
79 changes: 2 additions & 77 deletions docs/contributing.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,81 +1,6 @@
# Pre-requisites

## 1. Install dependencies

### pixi

[Pixi](https://pixi.sh/) is a package management tool for developers. It allows the developer to install libraries and applications in a reproducible way. Use pixi cross-platform, on Windows, Mac and Linux.

Installation:
```
curl -fsSL https://pixi.sh/install.sh | bash
```

Then logout and login and you can then install Python with:
```
pixi global install python==3.11
```

### pyenv

pyenv is a more conventional alternative to pixi. It installs slower but it's more tested. Use it if pixi doesn't work for you.

#### On Linux

In order to manage python versions, you can use the [pyenv
installer](https://github.com/pyenv/pyenv-installer).

Installing pyenv would be something like:

``` bash
curl https://pyenv.run | bash
```

Then log off and log back on, in order to ensure that the
`~/.local/bin` directory (used by `pip`) is
available in your session's `$PATH`, as well as the pyenv
shims directory.

#### On Mac OS

On Mac, pyenv can be installed with Brew https://brew.sh/
```bash
brew install pyenv
```

If you get an error `configure: error: C compiler cannot create executables`,
you may not have recent development tools. Run the following:
```bash
sudo rm -rf /Library/Developer/CommandLineTools
sudo xcode-select --install
```

You should verify that a new terminal session has added
the pyenv shims directory to your `$PATH`, then continue
in that new terminal session from now on.

### 2. Install the Python packages needed by the repo


#### Linux dependencies

pyenv will install a clean Python for you. This installation will
insist on a few important libraries which you should have on your
system before it installs our chosen Python development version.

```bash
sudo apt install -y libncurses-dev libbz2-dev libreadline-dev \
libssl-dev make build-essential libssl-dev zlib1g-dev \
libbz2-dev libreadline-dev libsqlite3-dev wget curl llvm \
libncursesw5-dev xz-utils tk-dev libxml2-dev libxmlsec1-dev \
libffi-dev liblzma-dev
```

Note: if the list of dependencies above changes, update the
[docker/Dockerfile] file accordingly, so CI stays in sync
with local development environments.

#### Rye installation
sasa-tomic marked this conversation as resolved.
Show resolved Hide resolved
## Rye installation

Rye is a comprehensive project and package management solution for Python.
sasa-tomic marked this conversation as resolved.
Show resolved Hide resolved
Rye provides a unified experience to install and manages Python installations,
Expand Down Expand Up @@ -209,5 +134,5 @@ To use the `dre` CLI tool with the local dashboard instance run it with `--dev`
E.g.

```sh
dre --dev subnet --id <id> replace -o1
dre --dev subnet replace --id <subnet-id> -o1
```
Loading