diff --git a/.hgignore b/.hgignore --- a/.hgignore +++ b/.hgignore @@ -51,4 +51,5 @@ syntax: regexp ^\.idea$ ^\.cache$ ^\.pytest_cache$ +^venv$ /__pycache__$ diff --git a/docs/contributing.rst b/docs/contributing.rst --- a/docs/contributing.rst +++ b/docs/contributing.rst @@ -33,8 +33,8 @@ bash shell:: hg clone https://kallithea-scm.org/repos/kallithea cd kallithea - python3 -m venv ../kallithea-venv - . ../kallithea-venv/bin/activate + python3 -m venv venv + . venv/bin/activate pip install --upgrade pip setuptools pip install --upgrade -e . -r dev_requirements.txt python-ldap python-pam kallithea-cli config-create my.ini diff --git a/docs/installation.rst b/docs/installation.rst --- a/docs/installation.rst +++ b/docs/installation.rst @@ -53,8 +53,8 @@ repository, use the following commands i hg clone https://kallithea-scm.org/repos/kallithea -u stable cd kallithea - python3 -m venv ../kallithea-venv - . ../kallithea-venv/bin/activate + python3 -m venv venv + . venv/bin/activate pip install --upgrade pip setuptools pip install --upgrade -e . python3 setup.py compile_catalog # for translation of the UI @@ -81,6 +81,8 @@ problematic when upgrading the system or An additional benefit of virtualenv is that it doesn't require root privileges. - Don't install as root - install as a dedicated user like ``kallithea``. + If necessary, create the top directory for the virtualenv (like + ``/srv/kallithea/venv``) as root and assign ownership to the user. - Create a new virtual environment, for example in ``/srv/kallithea/venv``, specifying the right Python binary:: diff --git a/docs/overview.rst b/docs/overview.rst --- a/docs/overview.rst +++ b/docs/overview.rst @@ -79,7 +79,7 @@ with home in ``/home/kallithea`` and pla For experiments, it might be convenient to run everything as yourself and work inside a clone of Kallithea, with the ``.ini`` and SQLite database in the root -of the clone. +of the clone, and a virtualenv in ``venv``. Python environment