Skip to content

Improve local development setup instructions in README #1079

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

Closed
Khiladi-786 wants to merge 4 commits into from
Closed

Improve local development setup instructions in README #1079

Changes from 2 commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
38bf567
Improve setup instructions for local development
Khiladi-786 Mar 22, 2026
06fa7d5
Improve setup instructions for local development
Khiladi-786 Mar 22, 2026
2ddf6d2
Improve setup instructions for local development
Khiladi-786 Mar 22, 2026
f11e49a
Improve port conflict error handling in server startup
Khiladi-786 Mar 22, 2026
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
16 changes: 16 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -179,6 +179,21 @@ Install from source
> pip install git+https://github.com/fossasia/visdom
```

## Local Development Setup (From Scratch)

### 1. Create environment
,,,bash
conda create -n visdom_env python=3.10 -y
conda activate visdom_env
pip install -r requirements.txt
pip install pillow charset-normalizer
pip install -e .
python example/demo.py

If you get module import errors:
export PYTHONPATH=$(pwd)/py
,,,bash

## Usage

Start the server (probably in a `screen` or `tmux`) from the command line:
Expand Down Expand Up @@ -800,3 +815,4 @@ See guidelines for contributing [here.](./CONTRIBUTING.md)

## Acknowledgments
Visdom was inspired by tools like [display](https://github.com/szym/display) and relies on [Plotly](https://plot.ly/) as a plotting front-end.

Loading