|
@@ -1,4 +1,4 @@
|
1
|
|
-[](https://travis-ci.org/tracim/tracim) [](https://coveralls.io/r/tracim/tracim) [](https://scrutinizer-ci.com/g/tracim/tracim/?branch=master)
|
|
1
|
+[](https://travis-ci.org/tracim/tracim) [](https://coveralls.io/r/tracim/tracim) [](https://scrutinizer-ci.com/g/tracim/tracim/?branch=master) [](https://pypi.python.org/pypi/tracim)
|
2
|
2
|
|
3
|
3
|
# Tracim - Introduction #
|
4
|
4
|
|
|
@@ -67,7 +67,7 @@ Tracim is licensed under the terms of the
|
67
|
67
|
|
68
|
68
|
Tracim is a web application:
|
69
|
69
|
|
70
|
|
-* developed with python >=3.4.
|
|
70
|
+* developed with python 3.4, 3.5, 3.6
|
71
|
71
|
* based on the [TurboGears](http://www.turbogears.org/) web framework.
|
72
|
72
|
* relying on [PostgreSQL](http://www.postgresql.org/) or [MySQL](https://www.mysql.fr/) or [sqlite](https://www.sqlite.org/) as the storage engine.
|
73
|
73
|
|
|
@@ -138,7 +138,7 @@ If you want use PostgreSQL as database engine:
|
138
|
138
|
|
139
|
139
|
Or if you want to use MySQL as database engine
|
140
|
140
|
|
141
|
|
- apt-get install mysql-server mysql-client libmysqlclient-dev
|
|
141
|
+ apt-get install mysql-server
|
142
|
142
|
|
143
|
143
|
Or if you want to use SQLite as database engine
|
144
|
144
|
|
|
@@ -163,7 +163,7 @@ To install frontend dependencies listed in the file package.json, proceed as fol
|
163
|
163
|
|
164
|
164
|
### Setting-up python virtualenv ###
|
165
|
165
|
|
166
|
|
-_Reminder : Tracim is developed and tested using python3.4._
|
|
166
|
+_Reminder : Tracim is developed and tested using python3.4, python3.5, python3.6._
|
167
|
167
|
|
168
|
168
|
We strongly recommend to use virtualenv as deployment environment. This ensure that there will be no conflict between system-wide python installation and Tracim required ones. To Create the virtual environment:
|
169
|
169
|
|
|
@@ -178,8 +178,6 @@ To install tracim and it's dependencies:
|
178
|
178
|
cd tracim && python setup.py develop && cd -
|
179
|
179
|
pip install -r install/requirements.txt
|
180
|
180
|
|
181
|
|
-**Note**: If you want to use MySQL database, please refer to Configuration/database schema note to install required package.
|
182
|
|
-
|
183
|
181
|
## Database Setup ##
|
184
|
182
|
|
185
|
183
|
### Minimalist introduction to PostgreSQL ###
|
|
@@ -257,7 +255,14 @@ In this case, delete the user and database you previously created (using pgtool)
|
257
|
255
|
|
258
|
256
|
### Minimalist introduction to MySQL ###
|
259
|
257
|
|
260
|
|
-## Create database ##
|
|
258
|
+#### Driver ####
|
|
259
|
+
|
|
260
|
+Tracim uses the PyMySQL driver between the SQLAlchemy ORM and the MySQL RDBMS.
|
|
261
|
+The only requirement is a pip installable package:
|
|
262
|
+
|
|
263
|
+ pip install PyMySQL
|
|
264
|
+
|
|
265
|
+#### Create database ####
|
261
|
266
|
|
262
|
267
|
Connect to mysql with root user (password has been set at "Installation" -> "Dependencies" chapter, when installing package)
|
263
|
268
|
|
|
@@ -304,9 +309,9 @@ Configure database in the development.ini file. This is defined as sqlalchemy.ur
|
304
|
309
|
|
305
|
310
|
sqlalchemy.url = postgresql://tracimuser:tracimpassword@127.0.0.1:5432/tracimdb?client_encoding=utf8
|
306
|
311
|
|
307
|
|
-There is an example value for MySQL below (please refer to Configuration/database schema note to install required package):
|
|
312
|
+There is an example value for MySQL below:
|
308
|
313
|
|
309
|
|
- sqlalchemy.url = mysql+oursql://tracimuser:tracimpassword@127.0.0.1/tracimdb
|
|
314
|
+ sqlalchemy.url = mysql+pymysql://tracimuser:tracimpassword@127.0.0.1/tracimdb
|
310
|
315
|
|
311
|
316
|
There is an example value for SQLite below :
|
312
|
317
|
|
|
@@ -421,8 +426,6 @@ or
|
421
|
426
|
|
422
|
427
|
The last step before to run the application is to initialize the database schema. This is done through the following command:
|
423
|
428
|
|
424
|
|
-**Note**: If you want to use MySQL database, please install this pip package: ```pip install https://launchpad.net/oursql/py3k/py3k-0.9.4/+download/oursql-0.9.4.zip```
|
425
|
|
-
|
426
|
429
|
cd tracim && gearbox setup-app && cd -
|
427
|
430
|
|
428
|
431
|
## Running the server ##
|