kallithea Changeset - 6bab917402b4

Changeset - 6bab917402b4

Parent rev.

Child rev.

[Not reviewed]

default

0 4 0

Mads Kiilerich (mads) - 6 years ago 2020-08-24 15:13:52
mads@kiilerich.com

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`

4 files changed with 8 insertions and 5 deletions:

.hgignore

docs/contributing.rst

docs/installation.rst

docs/overview.rst

0 comments (0 inline, 0 general)

.hgignore

➞

Show inline comments

@@ @@ -48,7 +48,8 @@ syntax: regexp @@
 ^Kallithea\.egg-info$
 ^my\.ini$
 ^fabfile.py
 ^\.idea$
 ^\.cache$
 ^\.pytest_cache$
 ^venv$
 /__pycache__$

docs/contributing.rst

➞

Show inline comments

@@ @@ -30,14 +30,14 @@ Getting started @@
 To get started with Kallithea development run the following commands in your
 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
         kallithea-cli db-create -c my.ini --user=user --email=user@example.com --password=password --repos=/tmp
         kallithea-cli front-end-build
         gearbox serve -c my.ini --reload &

docs/installation.rst

➞

Show inline comments

@@ @@ -50,14 +50,14 @@ Installation from repository source @@
 To install Kallithea in a virtualenv using the stable branch of the development
 repository, use the following commands in your bash shell::
         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
 .. note::
    This will install all Python dependencies into the virtualenv. Kallithea
@@ @@ -78,12 +78,14 @@ It is highly recommended to use a separa @@
 This way, all libraries required by Kallithea will be installed separately from your
 main Python installation and other applications and things will be less
 problematic when upgrading the system or Kallithea.
 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::
     python3 -m venv /srv/kallithea/venv

docs/overview.rst

➞

Show inline comments

@@ @@ -76,13 +76,13 @@ Kallithea can be installed in many diffe @@
 For simple setups, it is fine to just use something like a ``kallithea`` user
 with home in ``/home/kallithea`` and place everything there.
 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
 ------------------
 **Kallithea** is written entirely in Python_ and requires Python version

0 comments (0 inline, 0 general)