wordslab-notebooks-lib.env

Access wordslab-notebooks environment version, platform, urls, ports, directories (install / apps / data / models), and pre-installed models.

wordslab-notebooks environment variables

WordslabNotebooksEnv class is the entry point to explore the wordslab-notebooks environment variables.

WordslabEnv


def WordslabEnv(
    
):

Initialize self. See help(type(self)) for accurate signature.

env = WordslabEnv()

wordslab-notebooks version and platform

env.version

'2026-01'

env.platform

'WindowsSubsystemForLinux'

wordslab-notebooks external urls

env.url_dashboard

'http://192.168.1.16:8888'

env.url_openwebui

'https://192.168.1.16:8882'

env.url_jupyterlab

'https://192.168.1.16:8880'

env.url_vscode

'https://192.168.1.16:8881'

env.url_userapp1

'https://192.168.1.16:8883'

env.url_userapp2

'https://192.168.1.16:8884'

env.url_userapp3

'https://192.168.1.16:8885'

env.url_userapp4

'https://192.168.1.16:8886'

env.url_userapp5

'https://192.168.1.16:8887'

wordslab-notebooks internal ports

env.port_ollama

env.port_vllm

env.port_docling

env.port_userapp1

'8883'

env.port_userapp2

'8884'

env.port_userapp3

'8885'

env.port_userapp4

'8886'

env.port_userapp5

'8887'

wordslab-notebooks install directories

env.dir_home

'/home'

env.dir_scripts

'/home/wordslab-notebooks-2026-01'

env.dir_python

'/home/python'

env.dir_workspace

'/home/workspace'

env.dir_models

'/home/models'

wordslab-notebooks applications install directories

env.dir_openwebui

'/home/open-webui'

env.dir_jupyterlab

'/home/jupyterlab'

env.dir_vscode

'/home/code-server'

env.dir_ollama

'/home/ollama'

env.dir_docling

'/home/docling'

wordslab-notebooks applications data directories

env.dir_openwebui_data

'/home/workspace/.openwebui'

env.dir_jupyterlab_data

'/home/workspace/.jupyter'

env.dir_vscode_data

'/home/workspace/.codeserver'

env.dir_docling_data

'/home/workspace/.docling'

wordslab-notebooks models directories

env.dir_models_ollama

'/home/models/ollama'

env.dir_models_vllm

'/home/models/huggingface'

env.dir_models_hugginface

'/home/models/huggingface'

env.dir_models_fastai

'/home/models/fastai'

env.dir_models_pytorch

'/home/models/torch'

env.dir_models_keras

'/home/models/keras'

env.dir_models_tensorflow

'/home/models/tfhub_modules'

env.dir_models_docling

'/home/models/docling'

wordslab-notebooks default models

env.default_model_chat

'gemma3:27b'

env.default_model_code

'qwen3:30b'

env.default_model_agent

'glm-4.7-flash:q4_K_M'

env.default_model_embedding

'embeddinggemma:300m'

env.self.default_model_context_length

User-defined environment variables

You can save user-defined environment variables in the following file and they will be loaded by wordslab-notebooks each time a new shell is created:

$WORDSLAB_WORKSPACE/.secrets/user-env.bashrc

This module provides Python functions to programmatically manage these user-defined environment variables.

They should primarily be used to register API keys use to connect to external services.

WordslabEnv.write_user_env_var


def write_user_env_var(
    var_name:str, var_value:str
)->None:

Write or update an environment variable in $WORDSLAB_WORKSPACE/.secrets/user-env.bashrc

The file is created if it doesn’t exist. The variable is created if it doesn’t exist and updated if it already exist. The value is safely quoted for Bash while preserving $VAR references.

The new variable value is automatically injected in the current python process. The environment variable will be automatically loaded each time you start a new shell. But you need to restart all the currently running shells and other processes to see the new variable or value.

WordslabEnv.read_user_env_var


def read_user_env_var(
    var_name:str
)->Optional:

Read a variable value from $WORDSLAB_WORKSPACE/.secrets/user-env.bashrc

Returns the raw (unexpanded) value, or None if not found.

env.write_user_env_var("SECRETS_PATH", "$WORDSLAB_WORKSPACE/.secrets")

# !cat $WORDSLAB_WORKSPACE/.secrets/user-env.bashrc

os.environ["SECRETS_PATH"]

'/home/workspace/.secrets'

env.read_user_env_var("SECRETS_PATH")

'$WORDSLAB_WORKSPACE/.secrets'

Connections to external services

OpenRouter

WordslabEnv.setup_openrouter


def setup_openrouter(
    openrouter_api_key:str
)->None:

# env.setup_openrouter(openrouter_api_key="sk-...")

# env = WordslabEnv()
# env.cloud_openrouter_api_key

Replicate

WordslabEnv.setup_replicate


def setup_replicate(
    replicate_api_token:str
)->None:

# env.setup_replicate(replicate_api_token="r8_...")

# env = WordslabEnv()
# env.cloud_replicate_api_token

Tavily

WordslabEnv.setup_tavily


def setup_tavily(
    tavily_api_key:str
)->None:

# env.setup_tavily(tavily_api_key="tvly-...")

# env = WordslabEnv()
# env.cloud_tavily_api_key

Ollama cloud

WordslabEnv.setup_ollamacloud


def setup_ollamacloud(
    ollama_api_key:str
)->None:

# env.setup_ollamacloud(ollama_api_key="0d2...")

# env = WordslabEnv()
# env.cloud_ollama_api_key

Github

WordslabEnv.setup_github


def setup_github(
    git_user_name:str, git_user_email:str, github_username:str, github_access_token:str
)->None:

# env.setup_github(git_user_name="John Doe", git_user_email="john.doe@email.com", github_username="johndoe", github_access_token="ghp_...")

Wrote Github credentials

Huggingface

WordslabEnv.setup_huggingface


def setup_huggingface(
    huggingface_access_token:str
)->None:

# env.setup_huggingface(huggingface_access_token="hf_...")

# env = WordslabEnv()
# env.cloud_huggingface_access_token

Pypi

WordslabEnv.setup_pypi


def setup_pypi(
    pypi_api_token:str
)->None:

# env.setup_pypi(pypi_api_token="pypi-...")

Wrote Pypi credentials