Skip to content

Commit d00d72b

Browse files
authored
docs: add venv instructions in docs for beginners (#1222)
1 parent 477e98d commit d00d72b

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

docs/install.rst

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,19 @@ Requirements
2727
.. note::
2828
On Mac OS, by default, containers are allocated 2 GB of RAM, which is not enough. You should follow `these instructions from the official Docker documentation <https://docs.docker.com/docker-for-mac/#advanced>`__ to allocate at least 4-5 GB to the Docker daemon. If the deployment fails because of insufficient memory during database migrations, check the :ref:`relevant section in the troubleshooting guide <migrations_killed>`.
2929

30+
31+
Virtual Environment (Recommended)
32+
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
33+
34+
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:
35+
36+
.. code-block:: bash
37+
38+
python3 -m venv env
39+
source env/bin/activate
40+
41+
For more details on virtual environments, refer to the official `Python documentation <https://docs.python.org/3/library/venv.html>`_.
42+
3043
Download
3144
--------
3245

@@ -43,6 +56,7 @@ Check the "tutor" package on Pypi: https://pypi.org/project/tutor. You will need
4356

4457
.. _install_binary:
4558

59+
4660
Binary release
4761
~~~~~~~~~~~~~~
4862

0 commit comments

Comments
 (0)