Provide instructions and a requirements list to quickly start the sample
authorChristophe de Vienne <christophe@unlish.com>
Tue, 22 Jul 2014 23:45:11 +0200
changeset 11490 addf68740dbb
parent 11489 433fd3af7386
child 11491 6ba31f0c7d5a
Provide instructions and a requirements list to quickly start the sample application. Related to #4291173
sampleapp/README.txt
sampleapp/development.ini
sampleapp/requirements.txt
--- a/sampleapp/README.txt	Tue Jul 15 18:25:48 2014 +0200
+++ b/sampleapp/README.txt	Tue Jul 22 23:45:11 2014 +0200
@@ -1,13 +1,41 @@
-sampleapp README
+A sample application to test the pyramid_cubicweb library
+=========================================================
+
+Requirements
+------------
+
+System requirements
+~~~~~~~~~~~~~~~~~~~
 
-Before pip installing cubicweb, the following packages are required (on a
-ubuntu 14.04) :
+On a ubuntu 14.04::
+
+    sudo apt-get install libgecode-dev libxml2-dev libxslt1-dev python-dev \
+    libz-dev libpq-dev libtiff5-dev libfreetype6-dev
+
+Python requirements
+~~~~~~~~~~~~~~~~~~~
+
+::
 
-libgecode-dev
-libxml2-dev
-libxslt1-dev
+    pip install -r requirements.txt
+    (cd .. && python setup.py develop)
+    python setup.py develop
+
+
+Cubicweb instance
+~~~~~~~~~~~~~~~~~
+
+You need a postgresql server.
 
-python-dev
+::
+
+    export CW_MODE=user
+    cubicweb-ctl create blog test
+
 
-libz-dev
-libpq-dev
+Running the app
+---------------
+
+::
+
+    pserve --reload develop.ini
--- a/sampleapp/development.ini	Tue Jul 15 18:25:48 2014 +0200
+++ b/sampleapp/development.ini	Tue Jul 22 23:45:11 2014 +0200
@@ -7,9 +7,9 @@
 use = egg:sampleapp
 
 pyramid.reload_templates = true
-pyramid.debug_authorization = false
-pyramid.debug_notfound = false
-pyramid.debug_routematch = false
+pyramid.debug_authorization = true
+pyramid.debug_notfound = true
+pyramid.debug_routematch = true
 pyramid.default_locale_name = en
 pyramid.includes = 
     pyramid_debugtoolbar
@@ -28,7 +28,8 @@
 ###
 
 [server:main]
-use = egg:waitress#main
+#use = egg:waitress#main
+use = egg:pyramid#wsgiref
 host = 0.0.0.0
 port = 8080
 
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/sampleapp/requirements.txt	Tue Jul 22 23:45:11 2014 +0200
@@ -0,0 +1,30 @@
+Mako==1.0.0
+MarkupSafe==0.23
+PasteDeploy==1.5.2
+Pygments==1.6
+Twisted==14.0.0
+WebOb==1.4
+Yapps==2.2.0
+argparse==1.2.1
+cubicweb==3.19.3
+cubicweb-blog==1.10.1
+logilab-common==0.62.0
+logilab-constraint==0.5.0
+logilab-database==1.12.2
+logilab-mtconverter==0.8.2
+lxml==3.3.5
+passlib==1.6.2
+psycopg2==2.5.3
+pyramid==1.5.1
+pyramid-debugtoolbar==2.1
+pyramid-mako==1.0.2
+repoze.lru==0.6
+rql==0.33.0
+translationstring==1.1
+venusian==1.0
+waitress==0.8.9
+wsgiref==0.1.2
+yams==0.39.1
+zope.deprecation==4.1.1
+zope.interface==4.1.1
+..