Create a virtual environment where the dependencies will live::
$ virtualenv -p python3.6 python
$ python3 -m venv python
$ source python/bin/activate
(python)$
Change into the base directory of this software and install the project dependencies::
(python)$ pip3 install -r requirements.txt
(python)$ pip install -r requirements.txt
Setting up the configuration
-----------------------
----------------------------
By default the project is set up to run on a SQLite database.
Create a file pv/local_settings.py and add at least the following line::
Create a file ``pv/local_settings.py`` and add at least the following line::
SECRET_KEY = 'secret key'
(obviously replacing "secret key" with a key of your choice).
Setting up PostgreSQL
----------------
---------------------
We recommend using PostgreSQL in order to be able to use the collation utf8mb64_unicode_ci and thus being able to display all languages.
To use PostgreSQL, add the following to your local_settings.py (before migrating) and add your credentials::
To use PostgreSQL, add the following to your ``local_settings.py`` (before migrating) and add your credentials::
DATABASES = {
'default': {
...
...
@@ -75,13 +70,12 @@ To use PostgreSQL, add the following to your local_settings.py (before migrating
}
}
Setting up MySQL
----------------
**Note:** When adding your database, make sure you **don't** use the collation utf8mb4_unicode_ci or you will get a key length error during migration. (use e.g. utf8_general_ci instead).
To use MySQL, add the following to your local_settings.py (before migrating)::
To use MySQL, add the following to your ``local_settings.py`` (before migrating)::
DATABASES = {
'default': {
...
...
@@ -92,7 +86,7 @@ To use MySQL, add the following to your local_settings.py (before migrating)::
}
}
Create a file pv/mysql.cnf and give your MySQL credentials::
Create a file ``pv/mysql.cnf`` and give your MySQL credentials::
[client]
database =
...
...
@@ -102,20 +96,14 @@ Create a file pv/mysql.cnf and give your MySQL credentials::
