skipole 3.0.5

A WSGI Application generator

README

skipole is a framework for creating wsgi applications. A web admin interface, together with your own code, allows the developer to create dynamic web pages.

Skipole requires python 3.2 or later, and can be installed with:

pip install skipole

Starting a new project

To create a new project you would normally run:

python3 -m skipole myproj /path/to/projectfiles

You should replace 'myproj' with your preferred name for a new project. A projectfiles directory will be created with your new project 'myproj' and support files within it.

Within /path/to/projectfiles/myproj/code you will see a skeleton python file myproj.py, this contains code which generates the wsgi application, and functions which you will develop further yourself.

Developing a project

The framework provides a web based admin facility allowing you to create template pages of various types (html, json, css and svg) and also 'Responders' which are script 'pages' which call your functions defined in myproj.py

The developer runs:

python3 /path/to/projectfiles/myproj/code/myproj.py

then connects with a browser to localhost:8000 to view the project, and calls localhost:8000/skiadmin to open an administrative site to add and edit folders and pages.

'pages' are of several types, the main ones being template and responder pages. Typically you populate the templates with widgets, and set up the responders to accept an incoming call, and then route data from the call to your own functions in myproj.py. Your code sets data into a Python dictionary, which is set into a template page and returned to the caller.

Your Python functions in myproj.py are described in greater detail within the skiadmin pages. These functions would typically call further code of your own, to serve whatever data you require.

Special features

The dictionary of widget field values which you create are normally set into the returned template page, but they can also be set into a JSON file, which updates the widgets already displayed on the client browser. This enables facilities such as SVG meters and graphs to be dynamcally updated.

The widgets created have a look and feel set by CSS classes, you have the facility to set your own classes on the widgets to change their looks, and also to set 'default' classes on a per project basis.

Final output

When you have fully developed your application, and wish to deploy it, you would remove the lines in myproj.py which run the library wsgiref.simple_server, and which add the skiadmin web pages, and you will be left with your final WSGI 'application' - which can be served by any wsgi compatable web server.

Further information

The web admin pages have extensive documentation and help features, and the wiki at https://bitbucket.org/skipole/skipole has further documentation.