summaryrefslogtreecommitdiff
path: root/docs/source
diff options
context:
space:
mode:
authorAlfredo Deza <alfredodeza@gmail.com>2010-12-09 08:31:26 -0500
committerAlfredo Deza <alfredodeza@gmail.com>2010-12-09 08:31:26 -0500
commitf9a01be7137220deb13cb68bbc91f8998b7ee284 (patch)
treef650b9ad84a6f4b07dd26fb6a1750ce042b6d782 /docs/source
parentc1057b706fea5f246b94d1930101406f30ffbd9e (diff)
downloadpecan-f9a01be7137220deb13cb68bbc91f8998b7ee284.tar.gz
updating the quick start project for pecan
Diffstat (limited to 'docs/source')
-rw-r--r--docs/source/index.rst2
-rw-r--r--docs/source/quick_start.rst81
2 files changed, 67 insertions, 16 deletions
diff --git a/docs/source/index.rst b/docs/source/index.rst
index a6a8e31..d047e08 100644
--- a/docs/source/index.rst
+++ b/docs/source/index.rst
@@ -93,7 +93,7 @@ License
-------
The Pecan framework and the documentation is BSD Licensed::
- Copyright (c) <2010>, <Pecan Framework>
+ Copyright (c) <2010>, Pecan Framework
All rights reserved.
Redistribution and use in source and binary forms, with or without
diff --git a/docs/source/quick_start.rst b/docs/source/quick_start.rst
index 4d3110d..06ed488 100644
--- a/docs/source/quick_start.rst
+++ b/docs/source/quick_start.rst
@@ -55,8 +55,8 @@ this is how it looks like when we run the whole command::
This is how the structure of your new project should look like::
- test_project $ tree
.
+ ├── config.py
├── public
│   ├── css
│   │   └── style.css
@@ -73,22 +73,9 @@ This is how the structure of your new project should look like::
├── layout.html
└── success.html
- 6 directories, 9 files
+ 6 directories, 10 files
-.. _running_application:
-
-Running the application
------------------------
-The one file we are interested here is ``start.py``, if you just run it with
-Python it will bring up the development server and serve the app::
-
- python start.py
- Serving on http://0.0.0.0:8080
- serving on 0.0.0.0:8080 view at http://127.0.0.1:8080
-
-To get up and running in no time the template helps a lot!
-
A few things have been set for you, let's review them one by one:
* **public**: All your public static files like CSS and Javascript are placed
@@ -107,6 +94,70 @@ database for the app the template doesn't supply you one. In case you need it
later you could create a ``models.py`` file or a ``model`` directory.
+.. _running_application:
+
+Running the application
+-----------------------
+There are 2 files that are important to start your application. In this case
+``start.py`` and ``config.py`` are in charge of getting everything up and running.
+
+If you just run ``start.py`` with Python, passing ``config`` as an argument for
+configuration it will bring up the development server and serve the app::
+
+ python start.py config
+ Serving on http://0.0.0.0:8080
+ serving on 0.0.0.0:8080 view at http://127.0.0.1:8080
+
+To get up and running in no time the template helps a lot!
+
+.. note::
+ If you fail to pass an argument you will get a small error message asking
+ for a configuration file. Remember you need to pass the name of the
+ configuration file without the ".py" extension.
+
+
+Simple Configuration
+--------------------
+We mentioned that you get a Python file with some configurations. The only
+Python syntax that you will see is the first line that imports the
+RootController that is in turn placed as the application root. Everything else,
+including possible custom configurations are set as Python dictionaries.
+
+This is how your default configuration file should look like::
+
+ from test_project.controllers.root import RootController
+
+
+ # Server Specific Configurations
+ server = {
+ 'port' : '8080',
+ 'host' : '0.0.0.0'
+ }
+
+ # Pecan Application Configurations
+ app = {
+ 'root' : RootController(),
+ 'static_root' : 'public',
+ 'template_path' : 'test_project/templates',
+ 'debug' : True
+ }
+
+ # Custom Configurations must be in Python dictionary format::
+ #
+ # foo = {'bar':'baz'}
+ #
+ # All configurations are accessible at::
+ # pecan.conf
+
+
+**Nothing** in the configuration file above is actually required for Pecan to
+be able to run. If you fail to provide some values Pecan will fill in the
+missing things it needs to run.
+
+You also get the ability to set your own configurations as dictionaries and you
+get a commented out example on how to do that.
+
+
Root Controller
---------------
The Root Controller is the main point of contact between your application and