Skip to content

Clarify virtual environment setup instructions (Points 7 & 8) #513

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

Open
VanshikaSabharwal wants to merge 3 commits into
base: develop
Choose a base branch
from
Open

Clarify virtual environment setup instructions (Points 7 & 8) #513

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
8b07e58
updated the docs
VanshikaSabharwal Feb 24, 2026
fe214cb
updated with suggestion
VanshikaSabharwal Feb 27, 2026
405c7af
updated with suggestion
VanshikaSabharwal Feb 27, 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
9 changes: 6 additions & 3 deletions Installing-Oppia-(Linux;-Python-3).md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -167,7 +167,11 @@ exec "$SHELL"
> [!WARNING]
> Be careful with using graphical editors like Notepad in Windows. These can add carriage returns (`\r`) that confuse our Linux-based development tools. Instead, we recommend using editors designed for programming or command-line text editors.

7. Add new file called `.direnvrc` into your home (`~`) folder with this content:
7. Add new file called `.direnvrc` into your home (`~`) directory (also called your user’s root folder, e.g., `/home/your-username/`). You can also use the tilde (`~`) shorthand to refer to this directory in commands. To verify that you are in the correct directory, you can run:
```bash
pwd
```
This should print the path to your home directory. Then add the following content to `.direnvrc`:
```bash
use_python() {
local python_root=$(pyenv root)/versions/$1
Expand All @@ -184,8 +188,7 @@ exec "$SHELL"
> [!WARNING]
> Be careful with using graphical editors like Notepad in Windows. These can add carriage returns (`\r`) that confuse our Linux-based development tools. Instead, we recommend using editors designed for programming or command-line text editors.

8. Create a virtual environment for oppia by adding file named `.envrc` into the parent folder of the oppia repository
with this content:
Copy link
Copy Markdown
Member

@jayam04 jayam04 Mar 5, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you also specific path ../ or something similar.

Copy link
Copy Markdown
Author

@VanshikaSabharwal VanshikaSabharwal Mar 7, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think there is no as such path for this. Can you please specify a path if you have in mind?

8. Create a virtual environment for oppia by adding file named `.envrc` into the oppia root folder with this content:

```console
use python 3.10.16
Expand Down
Loading