Getting started
===============

Shabti can be installed from the Cheeseshop using setuptools in the usual approved manner:

.. code-block :: bash

    $ easy_install Shabti

The latest development version can be downloaded from the Mercurial repository listed on the Shabti Bitbucket project page.

.. code-block :: bash

    $ hg clone http://bitbucket.org/gjhiggins/shabti/
    
followed by

.. code-block :: bash

    $ python setup.py develop

Creating an application using Shabti templates
----------------------------------------------

As is standard practice with Pylons, a new skeleton application is created by using ``paster``:

.. code-block :: bash

    $ paster create -t <template_name> <project-name>

The command:

.. code-block :: bash

    paster create --list-templates
    
will show a list of available application templates. 

The Shabti templates are:

    **shabti** :: default Shabti project template, provides Pylons and Elixir on top of SQLAlchemy

    **shabti_auth** :: creates additional code for a simple identity model for handling authentication

    **shabti_auth_xp** :: as shabti_auth but with row-level permissions (experimental)

    **shabti_auth_repozewho** :: as shabti_auth but uses repoze.who authentication

    **shabti_auth_repozewhat** :: as shabti_repozwhowho but uses repoze.what authorization

    **shabti_auth_repozepylons** :: repoze.who authent'n, repoze.what authoriz'n esp. for Pylons

    **shabti_auth_couchdb** :: as shabti_auth but uses CouchDB as a data store

    **shabti_auth_rdfalchemy** :: as shabti_auth but uses RDFAlchemy as ORM

    **shabti_rdfalchemy** :: provides RDFAlchemy ORM - Object-RDF Mapper

    **shabti_authplus** :: uses standard auth'n'auth, provides basic user accounts

    **shabti_humanoid** :: uses PylonsHQ auth'n'auth (SQLAlchemy model), provides basic user accounts

    **shabti_rdflib** :: provides RDF graph store and processing plus SPARQL graph querying 

    **shabti_microsite** :: auth'n'auth, tw.forms, a micro-CMS and a fluid vari-column layout

    **shabti_quickwiki** :: the Pylons QuickWiki tutorial adapted to use elixir for modelling

    **shabti_shenu** :: a partially-complete blogging app

The ``shabti_auth_xp`` template is experimental. This will be merged with ``shabti_auth`` at some point in the future (possibly in version 0.4). The ``shabti_auth`` template features are explained in further detail in later sections of this document.