Commit 5042a388 authored by Constantinos Venetsanopoulos's avatar Constantinos Venetsanopoulos
Browse files

Merge old snf-webproject README file into docs

parent 255bfaa1
Synnefo web project
===================
A synnefo helper package to ease up the deployment of synnefo components.
The package wraps a django project which extends itself (urls, default_settings,
installed_apps, middleware_classes) based on the synnefo components/packages
installed on the system.
The extending mechanism is based on the python setuptools `entry_points`. So
if an application (synnefo component) wants to plug additional configuration
to the django project it should define within its setup.py file the 'synnefo'
appropriate entry_points.
For usage example please take a look how snf-cyclades-app package defines its entry
points in:
- snf-cyclades-app/setup.py
- snf-cyclades-app/app_settings/__init__.py
...@@ -3,16 +3,31 @@ ...@@ -3,16 +3,31 @@
Component snf-webproject Component snf-webproject
======================== ========================
synnefo component :ref:`snf-webproject <snf-webproject>` defines a Django Synnefo component :ref:`snf-webproject <snf-webproject>` defines a Django
project in which the various other synnefo components project in which the various other Synnefo components
(:ref:`snf-cyclades-app <snf-cyclades-app>`, (:ref:`snf-cyclades-app <snf-cyclades-app>`,
:ref:`snf-pithos-app <snf-pithos-app>`, etc.) may run. :ref:`snf-pithos-app <snf-pithos-app>`, etc.) may run.
It provides a standard mechanism for every synnefo software component to modify It provides a standard mechanism for every Synnefo software component to modify
the list of Django apps to be executed inside the project (``INSTALLED_APPS``), the list of Django apps to be executed inside the project (``INSTALLED_APPS``),
modify the list of middleware classes (``MIDDLEWARE_CLASSES``) and add its own modify the list of middleware classes (``MIDDLEWARE_CLASSES``) and add its own
URL patterns. URL patterns.
In other words, wraps a Django project which extends itself (URLs,
default_settings, installed_apps, middleware_classes) based on the Synnefo
components/packages installed on the system.
The extending mechanism is based on the python setuptools `entry_points`. So if
an application (Synnefo component) wants to plug additional configuration to
the Django project, it should define within its setup.py file the 'synnefo'
appropriate entry_points.
For usage example please take a look how snf-cyclades-app package defines its entry
points in:
- snf-cyclades-app/setup.py
- snf-cyclades-app/app_settings/__init__.py
.. todo:: Document snf-webproject facilities for developers .. todo:: Document snf-webproject facilities for developers
Package installation Package installation
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment