CONTRIBUTING.md

Contribution guidelines

Setup

Regardless of how you develop, you need a Python environment to run pre-commit hooks.

# to manage multiple python versions easily use pyenv.
# see what versions of Python are available; install 3.10+ if not available
pyenv versions
pyenv install 3.11.1
pyenv local 3.11.1

# install poetry (MAC)
curl -sSL https://install.python-poetry.org | python3 -

# if you are using pyenv, add following config
# Poetry will then try to find the current python of your shell.
poetry config virtualenvs.prefer-active-python true

# Beaver uses River and River depends on Rust,
# need to install Rust compiler first (for UNIX based systems)
poetry run curl --proto '=https' --tlsv1.2 -sSf https://sh.rustup.rs | sh

# install requirements, this will also create virtualenv
poetry install
poetry install --with sdk

# to see where dependencies have been installed run
poetry env info

# install pre-commit (this will use poetry virtual env)
poetry run pre-commit install

🐍 Developping with Python

Once that's done, you just have to activate the environment.

poetry shell

Now you can run the server.

uvicorn beaver.main:app --port 8000 --reload --reload-dir beaver

And also run unit tests.

pytest

And also run the web interface.

export BEAVER_HOST=http://localhost
streamlit run ui/Home.py

🐳 Developping with Docker

git clone https://github.com/online-ml/beaver
cd beaver

# Run the stack
docker compose up --build -d

# See what's running
docker stats
# or
docker-compose ps

# Follow the logs for a particular service
docker compose logs celery -f

# Stop
docker compose down

# Clean slate
docker compose down --rmi all -v --remove-orphans

Releasing

docker buildx build --platform linux/amd64,linux/arm64 --push -t ghcr.io/online-ml/beaver:latest .