Skip to content

fix: add venv instructions in docs for beginners #1222

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

Merged
DawoudSheraz merged 3 commits into from
May 14, 2025
Merged

fix: add venv instructions in docs for beginners #1222

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
1b16121
fix: add venv instructions in docs for beginners
hinakhadim Apr 16, 2025
65ed2b9
fix: python venv doc link
hinakhadim Apr 17, 2025
3cd9ef7
fix: move virtual env section to Requirements section
hinakhadim May 5, 2025
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
13 changes: 13 additions & 0 deletions docs/install.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -43,6 +43,19 @@ Check the "tutor" package on Pypi: https://pypi.org/project/tutor. You will need

.. _install_binary:


Virtual Environment (Recommended)
Copy link
Copy Markdown
Contributor

@DawoudSheraz DawoudSheraz Apr 18, 2025

Choose a reason for hiding this comment

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

Let's add this in Requirements section

Copy link
Copy Markdown
Contributor Author

@hinakhadim hinakhadim May 5, 2025

Choose a reason for hiding this comment

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

I have moved this into the Requirements section

~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

To prevent conflicts with other Python packages and maintain a clean environment, it's recommended that Tutor should be installed within a Python virtual environment. This is especially important on fresh or shared systems where installing packages globally may require elevated privileges and can interfere with system-level Python dependencies:

.. code-block:: bash

python3 -m venv env
source env/bin/activate

For more details on virtual environments, refer to the official `Python documentation <https://docs.python.org/3/library/venv.html>`_.

Binary release
~~~~~~~~~~~~~~

Expand Down