[Micro task] Set up your local development environment for Bokeh

[pavithraes]

Go through the Bokeh's developer documentation to setup your local environment to work on Bokeh's codebase and documentation, and share a screenshot of your local documentation build.

Important pages/sections:

• Setting up a development environment
• Setting up and building Bokeh’s documentation

❗️Note:

Please follow the instructions in the most recent developer documentation here: https://docs.bokeh.org/en/latest/docs/dev_guide/setup.html to set up your development environment. These include some additional notes to ensure you have the tags necessary in your GitHub fork of Bokeh, for an accurate editable install. Your installation is correct if the output of python -m bokeh info has a "Bokeh version" similar to:

Python version      :  3.10.9 | packaged by conda-forge | (main, Feb  2 2023, 20:24:27) [Clang 14.0.6 ]
IPython version     :  8.11.0
Tornado version     :  6.2
Bokeh version       :  3.1.0rc1+2.g8b073e04
BokehJS static path :  /Users/pavithraes/Developer/Bokeh/bokeh/src/bokeh/server/static
node.js version     :  v18.13.0
npm version         :  8.19.4
Operating system    :  macOS-13.2.1-x86_64-i386-64bit

[chinmaychahar]

Hi @pavithraes
I'm interested in contributing to bokeh and have set up a local dev environment as directed in the instructions. Attaching some
screenshots for your reference

[bellatrick]

@pavithraes here is my screenshot for setting up the local development environment.

[Aman-Jamshed]

Hey @pavithraes. I've also setup the local dev environment on ubuntu and while I was setting I found two bugs in the documentation.First is, there is no file named as marker_map.py inside bokeh/examples/plotting/ and second is, the path BOKEH_DEV=false python -m bokeh serve --show examples/app/sliders.py should be BOKEH_DEV=false python -m bokeh serve --show examples/server/app/sliders.py.
It will be good if we edit the doc because this is time taking and giving errors. What do you say?

Here my screenshots of local dev environment.

[Soot3]

Edited the doc with the links to the executables.

bokeh/bokeh#12910
Marker_map.py had already been updated but it doesn't show on the site

[pavithraes]

@chinmaychahar @bellatrick @Aman-Jamshed @Soot3 Hi, thanks for working on this task! I've updated the description with an important note:

Please follow the instructions in the more recent developer documentation here: https://docs.bokeh.org/en/dev-3.1/docs/dev_guide (note that the version selector says 3.1.0rc1) to set up your development environment. These include some additional notes to ensure you have the tags necessary in your GitHub fork of Bokeh, for an accurate editable install.

From your screenshots, I think you may not have the correct Bokeh installed.

Especially @chinmaychahar @bellatrick -- Looks like you both have an older version of Bokeh.

Let me know if you have any question here or on Slack!

[chinmaychahar]

Hey @pavithraes thanks for the heads up! Have updated bokeh's version on my local machine accordingly.

[octonawish-akcodes]

Development setup local configurations

@pavithraes Please check have I successfully completed the micro task?

Documentation setup at localhost

[Soot3]

[Med16-11]

@pavithraes hey! I have successfully set up the local development environment for Bokeh.

[Chinemelu4]

Hi @pavithraes
I have set up the my local environment as requested, here is a screen shot of my local documentation build

[robinokwanma]

Here's my local environment build.

[AnishereMariam]

Hi @pavithraes, and everyone on this page, I am having some issues with setting up my dev environment. It is my first time working on open-source, and I would really appreciate getting some help here.

This has been going on for almost an hour. I am worried something is wrong.

[chinmaychahar]

@AnishereMariam could you share some more context? What commands are you running which leads to this output?

[AnishereMariam]

@chinmaychahar, I was able to fix the problem. I realized that there was actually no problem, to begin with. I just needed to open a new conda prompt to test my environment, and it works fine now, thank you.

@pavithraes, I have set up my local environment, and below are the attached screenshots, as requested.

[Isaakkamau]

Hello, @pavithraes I have successfully set up the local development environment for Bokeh.

[sjjssl]

Hi, @pavithraes I have successfully set up the environment.

[PatChizzy]

env up and running

[pavithraes]

Thanks for the screenshots, folks!

@PatChizzy You seem to have an older version of Bokeh, the current version is 3.1.0 :)

Other than that, eveyone's setup looks right to me ✨

[PatChizzy]

Member

Thank you @pavithraes i've installed and update...

[Faith-Nchifor]

Hello @pavithraes, Thank you for the instructions. I have the bokeh set up and running on my machine.

[BhaswatiRoy]

Hello

1. Terminal display of Bokeh

3. Application display in local host

[Ajoke23]

@pavithraes @bryevdv I have completed this task, I await your feedback. Thank you

[bryevdv]

@Ajoke23 that looks good to me!

A quick note for everyone though, just FYI if you see a version like "3.1.0" that means you have a released version installed in the current conda env. If the development version is installed, then the version will look more like

Bokeh version       :  3.1.0rc1+19.gc63e5c95

i.e. with all the extra parts tacked on to the end that identify the specific commit that the dev version is on etc.

Most of the actual work can be done with a released rather than a development version, so if you've gone through all the dev setup, it probably just means either that:

• you ran bokeh info from a different conda env than the setup steps
• you installed a released bokeh version after finishing the setup steps

Most of the actual work can be done just fine with a release version though, so that is fine! (It's just good to go through the setup to get all teh dev dependencies installed, especially if you need to build the docs).

[Faith-Nchifor]

Thank you @bryevdv. I actually switched to this development version because It was what was recommended in this micro task. Should we switch to released version?

[bryevdv]

@Faith-Nchifor The main reason we wanted everyone to run through the dev setup was because going through the steps makes sure you have all the extra dev dependencies installed. But once that is done, for most of the other tasks, it is fine to use either the dev version, or a release version.

[Faith-Nchifor]

Okay. Noted
Thank you for the clarification @bryevdv