Skipole WSGI generator.

Topics:

Introduction Your Code start_call submit_data end_call skicall skicall.page_data

Development at Bitbucket:

Skipole Project Documentation Downloads

skipole - getting started

Assuming you have installed skipole, the package can be imported into your code like any Python package, using 'import skipole'.

However, it also provides a useful feature when run directly. In which case it creates a skeleton project, together with needed support files.

To test this, run:

python3 -m skipole --version

Which should result in a string such as "3.0.0" being displayed.

You can now create a directory where projects will be developed, and a new project 'myproj'.

python3 -m skipole myproj /path/to/my/projectfiles

You should replace 'myproj' with your preferred name for a new project.

The /path/to/my/projectfiles should be to a directory where you will be developing your new project.

The projectfiles directory will be created with your new project 'myproj' within it:

...projectfiles/myproj/code/myproj.py

...projectfiles/myproj/data/....

...projectfiles/myproj/static/....

As well as myproj, you will see two other projects automatically created:

skis - a project serving needed javascript files, necessary for all projects

skiadmin - a project used to help develop 'myproj'

'myproj' is an optional argument. If not given then only the skis and skiadmin projects will be created.

The path "/path/to/my/projectfiles" must be given, and is the path to a directory of your choice where you will develop your project. Multiple projects can be created in one 'projectfiles' directory, or you could have multiple such directories holding different projects.

If the directory already exists, any existing skiadmin and skis projects will be overwritten, this facility is used to upgrade skis and skiadmin if a new version of skipole is installed.

If myproj already exists in the directory, it will not be changed.

The python file myproj.py contains code which imports skipole, and generates the wsgi application, and functions which you will develop further yourself. It also adds the skiadmin and skis 'sub-projects' to your new project. It is strongly commented so you should inspect it. You would then run:

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

Then connect with a browser to localhost:8000 to view the project, and call localhost:8000/skiadmin to open an administrative site to add and edit folders and pages.

To stop the project from serving, in the terminal press ctrl-c

Upgrading

Assuming you have installed skipole using pip, to upgrade to the latest version:

pip install --upgrade skipole

Check you have the latest with:

python3 -m skipole --version

Then, for each of the locations where you are developing projects:

python3 -m skipole /path/to/projectfiles

This will cause the skiadmin and skis projects under projectfiles to be replaced with the latest versions.