Mercurial > kallithea
changeset 8634:6bab917402b4
docs: when using venv with a clone, recommend using 'venv' as location
Avoid having the odd inconsistent location ../kallithea-venv to care about.
For good or bad, this might change how it is feasible to grep. I usually make
sure to only search tracked files:
grep Foo `hg mani`
author | Mads Kiilerich <mads@kiilerich.com> |
---|---|
date | Mon, 24 Aug 2020 15:13:52 +0200 |
parents | c354d1a7537f |
children | c819a1e9103b |
files | .hgignore docs/contributing.rst docs/installation.rst docs/overview.rst |
diffstat | 4 files changed, 8 insertions(+), 5 deletions(-) [+] |
line wrap: on
line diff
--- a/.hgignore Mon Aug 24 15:02:16 2020 +0200 +++ b/.hgignore Mon Aug 24 15:13:52 2020 +0200 @@ -51,4 +51,5 @@ ^\.idea$ ^\.cache$ ^\.pytest_cache$ +^venv$ /__pycache__$
--- a/docs/contributing.rst Mon Aug 24 15:02:16 2020 +0200 +++ b/docs/contributing.rst Mon Aug 24 15:13:52 2020 +0200 @@ -33,8 +33,8 @@ 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
--- a/docs/installation.rst Mon Aug 24 15:02:16 2020 +0200 +++ b/docs/installation.rst Mon Aug 24 15:13:52 2020 +0200 @@ -53,8 +53,8 @@ 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 @@ 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::
--- a/docs/overview.rst Mon Aug 24 15:02:16 2020 +0200 +++ b/docs/overview.rst Mon Aug 24 15:13:52 2020 +0200 @@ -79,7 +79,7 @@ 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