Karrigell

Karrigell est un canevas (framework) de développement web écrit en Python très simple d'utilisation.

À l'inverse d'autres frameworks écrits en Python, il ne nécessite pas d'apprendre un métalangage, car il reste très proche de la syntaxe python. Le code est donc simple à écrire et facile à maintenir.

Karrigell intègre un serveur web très efficace, mais il peut aussi travailler derrière d'autres serveurs web (Apache, Lighttpd et Xitami...).

Les bases de données courantes (sqlite, MySql, PostGresQL, etc.) peuvent être utilisées, cependant Karrigell inclut la base Buzhug, écrite par l'auteur, dans le même esprit que Karrigell.

Intérêt de Karrigell

Tout comme le PHP, Karrigell permet d’intégrer des scripts python à l’intérieur d’un document html en utilisant les symboles "<%" … "%>". Mais on peut également inclure du code HTML dans des scripts python.

Karrigell permet également de créer des sites d'une seule pièce, avec un service Karrigell (fichier .ks) dont les fonctions sont considérées comme des pages. Les fonctions dont le nom commencent par '_' sont privées.

L'utilisation du "karrigell service" (.ks) permet cependant d'avoir une certaine logique d'application dans un seul script. En outre, il est tout à fait possible d'inclure des scripts, ou des modules afin d'améliorer la lisibilité du script.

Karrigell offre un puissant système de template nommé cheetah et propose un module HTMLTags pour des balises HTML valides.

Installation de Karrigell

Décompresser le fichier que vous avez téléchargé (au format .zip, .tgz ou .tar.bz2) dans un répertoire tel que /home/myname/karrigell puis se placer dans le répertoire Karrigell-2.4.0.

Ouvrez une fenêtre console (un terminal), mettez-vous dans le Karrigell-2.4.0 (cd /home/myname/karrigell/Karrigell-2.4.0) et exécutez :

python Karrigell.py 

Vous devriez voir apparaître le message :

Karrigell 2.4.0 running on port 80
Type Ctrl+C to stop 

Configuration de Karrigell, mon premier site

Pour tester les exemples suivants, créons le repertoire "monsite" de notre site dans Karrigell-2.4.0/webapps/monsite

Puis se placer dans Karrigell-2.4.0/conf/ et ouvrir le fichier Karrigell.ini

Modifier les variables :<syntaxhighlight lang="cfg"> [Directories]

root = /home/myname/karrigell/Karrigell-2.4.0/webapps/monsite

[VirtualHost monsite.net]

root = /home/myname/karrigell/Karrigell-2.4.0/webapps/monsite

[Server]

port=8081 </syntaxhighlight>

Ainsi lorsqu'on relancera le serveur, dans le terminal :

python Karrigell.py 

Il affichera:

Karrigell 2.4.0 running on port 8081
Type Ctrl+C to stop 

Il suffit alors de se connecter en localhost via le navigateur: http://localhost:8081

Exemple de script python dans un document HTML

Dans le répertoire "monsite", créer un fichier index.html<syntaxhighlight lang="html">

La date courante est: <% import time print time.strftime("%d:%m:%y",time.localtime(time.time())) %>

</syntaxhighlight>

Puis avec le navigateur : http://localhost:8081

Exemple de code HTML dans un script Python

Dans le répertoire "monsite", créer un fichier index.py<syntaxhighlight lang="html5"> telephone={'guitare - chant':'Jean-Louis Aubert',

          'guitare':'Louis Bertignac',
          'basse':'Corine Marienneau',
          'batterie':'Richard Kolinka'}

"""

Le plus grand groupe français

""" for item in telephone.keys(): print "" %(item,telephone[item]) "

%s

%s

"

</syntaxhighlight>

Puis avec le navigateur : http://localhost:8081

Exemple de script Karrigell Service

Dans le répertoire "monsite", créer un fichier index.ks dans lequel on inclut le code suivant :<syntaxhighlight lang="python"> def index():

   print '<a href="page1?nom=bar">Aller vers foo</a>' 
   

def page1(nom):

   print '<IMG SRC="../picture.jpg">' 
   print nom

</syntaxhighlight>

Puis avec le navigateur : http://localhost:8081

Exemple d'importation de module dans un script Karrigell Service

Dans le répertoire "monsite", créer un fichier conf.cfg, un script index.ks, et un script maconfig.py qui sera le module.

Le fichier conf.cfg :<syntaxhighlight lang="cfg"> [DEFAULT]

1. Chemin par défaut où sera installée la base buzhug.
2. Décommenter pour activer la variable de configuration
3. path = /tmp/test

path = /home/monpseudo/karrigell/webapps/monsite/mabase/ </syntaxhighlight>

le script index.ks<syntaxhighlight lang="python">

1. !/usr/bin/python
2. -*- coding: iso-8859-1 -*-

import os, sys from maconfig import Konfig

def index():

   maconfig = Konfig() 
   print maconfig.lire_chemin_base_config()

</syntaxhighlight>

Le module maconfig.py:<syntaxhighlight lang="python">

1. !/usr/bin/python
2. -*- coding: iso-8859-1 -*-

from ConfigParser import * import os

class Konfig (object):

   """ 
   Objectif: Lire le fichier de configuration et renvoyer son contenu. 
   usage : 
   x.lire_chemin_base_config() 
   """ 
   def lire_chemin_base_config(self): 
       """
       Renvoie la valeur de path du fichier de configuration 
       """ 
       # tester si le fichier existe et le lire. Renvoi le résultat 
       if os.path.exists('conf.cfg'): 
           configdict = ConfigParser()
           configdict.read('conf.cfg') 
           self.path = configdict.defaults()['path'] 
           
           return self.path

</syntaxhighlight>

Karrigell Intègre

• Un serveur web
• Implémentation d'un mécanisme d'authentification et de gestion des utilisateurs
• Des sessions
• Accès facile aux données d'environnement, formulaires et base de données (Buzhug)
• Moteur de template Cheetah

Extensions

La liste exclut les extensions normalement prises en charge par un serveur

• .hip : HTML Inside Python
• .pih : Python Inside HTML
• .py : Fichier Python/ironpython
• .ks : "Karrigell service" = script Python dans lequel les fonctions sont associées à une URL

Voir aussi

Liens internes

• (fr) zope(français)
• (fr) buzhug(français) Base de données rapide en pur python écrite par l'auteur de Karrigell

Liens externes

• (en) Site officiel (anglais)
• (en) Site officiel de la version Version 3.0
• (fr) Site officiel (français)
• (en) buzhug (base de données en Python)
• (en) xRope (IDE de développement Python qui supporte le format de fichiers Karrigell)

Article publié sur Wikimonde Plus