Un site avec Pelican : #1 Installer et configurer Pelican

Sat 22 March 2014 | Damien Pelican

Vous voulez vous lancer dans la création d’un site avec Pelican ?

Bien que facile d’accès et d’utilisation, vous trouverez dans cette série d’articles toutes les informations pour obtenir un site rapidement et entièrement customisé.

Attention
La majorité des manipulations tout au long des tutoriaux se font en ligne de commande.

Installation de Python et de Pelican

Python

Vous devez tout d’abrd avoir Python d’installé sur votre poste. Vous pouvez utiliser python 2.7 ou 3.3 (il semblerait que la version 3.4 ne soit pas encore parfaitement prise en compte).

Pour installer python, vous pouvez aller voir sur le site officiel : http://www.python.org

A noter que vous devez également installer PIP, le gestionnaire de paquets de Python (qui n’est pas installé automatiquement avant la version 3.4 de Python).

Vous trouverez toutes les informations nécessaires dans la documentation officielle : http://pip.readthedocs.org/en/latest/installing.html

Pelican

Une fois que Python et PIP sont bien installés vous devez installer Pelican. Pas de panique ça se fait facilement de puis la ligne de commande :

$ pip install pelican
Warning
Suivant votre système, il est possible de que vous deviez lancer la commande en tant que super-administrateur.

Créer notre premier site

Commencer un site avec Pelican est très simple; saisissez la comande suivante là où vous voulez créer le site.

$ pelican-quickstart

S’ensuis une liste de questions auxquelles vous allez devoir répondre :

  • Where do you want to create your new web site? [.]

    Donnez l’emplacement où vous voulez créer le site (par défaut le dossier où vous vous trouvez).

  • What will be the title of this web site?

    Saisissez le nom que vous voulez donner à votre site.

  • Who will be the author of this web site?

    Saissiez le nom du rédacteur principale (ou du rédacteur tout cours si vous êtes seuls).

  • What will be the default language of this web site?

    Donnez le code de la langue principale du site (mettez “fr” par exemple).

  • Do you want to specify a URL prefix? e.g., http://example.com

    Voulez-vous inclure un préfixe dans les liens générés ? (‘Y’ pour oui, ‘n’ pour non).

  • What is your URL prefix? (see above example; no trailing slash)

    Si vous avez répondus oui juste avant, vous devez donner le préfixe (sans le ‘/’ finale).

  • Do you want to enable article pagination?

    Voules-vous une pagniation au niveau des articles ? (‘Y’ pour oui, ‘n’ pour non). Si vous dites non, tous les articles seront affichés sur une seule page.

  • How many articles per page do you want? [10]

    Si vous avez répondus oui à la question précédente, vous devez dire combien d’articles vous voulez par page (par défaut 10).

  • Do you want to generate a Fabfile/Makefile to automate generation and publishing?

    Voulez-vous que Pelican génére un fichier Fabfile et un fichier Makefile afin de vous simplifier la génération et la publication du site ? Il est fortement recommandé de dire oui (‘Y’). C’est d’ailleurs la valeur par défaut. La suite des tutoriaux utiliseras le fichier Makefile !

  • Do you want an auto-reload & simpleHTTP script to assist with theme and site development?

    Voulez-vous un script (intégré au Makefile) pour recharger les fichiers pendant le développement du site ? Là aussi dites oui (‘Y’). Vous pourriez très bien faire sans, mais il faudrais dans ce cas tapper les mêmes commandes continellement en parallèle de vos modifications et ça, à mon avis, c’est pas super pratique.

Les prochaines questions vont fortement dépendre de où et comment vous comptez heberger votre site. Si vous n’êtes pas certains de ce que vous faites ou devez faire, répondez non aux questions.

Ensuite pour chacun des oui que vous allez donner, des informations supplémentaires vous seront demandées. Je ne les énumère pas ici car ce n’est pas nécessaire dans le cadre de ce tutoriel.

  • Do you want to upload your website using FTP?

    Répondez oui (‘Y’) si vous souhaitez uploader votre site via un accès FTP (comme ça peut être le cas sur les hebergements mutualisés).

  • Do you want to upload your website using SSH?

    Répondez oui (‘Y’) si vous devez uploader votre site via une connection sécurisée (SSH ou SFTP). C’est par exemple le cas sur les serveurs dédiés qui sont souvent livrés sans accès FTP mais juste un accès SSH.

  • Do you want to upload your website using Dropbox?

    Répondz oui (‘Y’) si vous souhaitez mettre votre site en ligne via le partage de fichiers de Dropbox [1].

  • Do you want to upload your website using S3?

    Répondez oui (‘Y’) si vous souhaitez heberger votre site sur le cloud d’Amazon.

  • Do you want to upload your website using Rackspace Cloud Files?

    Répondez oui (‘Y’) si vous souhaitez heberger votre site via Rackspace.

Une fois que vous aurez répondus à ces questions, votre site est généré et vous n’avez plus qu’à le configurer plus en détails pour l’ajuster à vos besoins.

Configurer Pelican

Vous pouvez maintenant aller voir la structure de dossier de votre site Pelican.

Cependant, nous n’allons traiter dans ce tutorial que du fichier pelicanconf.py .

Modifier le titre et les autres paramètres

Si vous voulez modifier le titre du site (que vous avez normalement donné avec l’assistant), vous pouvez directement modifier la chaine de texte dans le fichier de configuration [2] :

SITENAME = u"Mon premier site avec Pelican"
À noter
Comme précisé dans la documentation officielle de Pelican, les variables doivent obligatoirement être mises en majuscules. Autrement elles ne seront pas traitées par Pelican.

Installer des plugins

Pelican permet d’utiliser des plugins afin d’étendre ses fonctionnalitées; cependant, elles ne sont pas incluses et vous devez les télécharger et les ajouter manuellement à Pelican.

Téléchargez les plugins

Tous les plugins officiels sont disponibles sur le repository Github dédie : https://github.com/getpelican/pelican-plugins.

Vous pouvez donc :

  • Soit télécharger l’archive générée par Github : master.zip
  • Soit en clonant le repository dans le dossier de votre site :
$ git clone https://github.com/getpelican/pelican-plugins.git plugins

Installer les plugins

Il faut ensuite rajouter les lignes suivantes dans votre fichier de configuration [3] :

PLUGIN_PATH = "plugins"
PLUGINS = []

PLUGINS est un tableau dans lequel vous rajouterez les noms des plugins que vous voulez ajouter à votre site Pelican (le nom du plugin est le nom du dossier).

Par exemple :

PLUGINS = [
    'assets',
    'sitemap'
]
Important
Pensez à regarder la documentation de chaque plugin que vous activez car il n’est pas impossible que celui-ci nécessite des librairies supplémentaires. Il faudras dans ce cas les installer en suivant la documentation du plugin (rassurez-vous, il s’agit souvent d’installation automatique via pip ).

Fin de cette première partie

Voilà, vous avez installé et configuré dans les grandes lignes votre premier site Pelican. Nous verrons bientôt dans un nouveau tutoriel comment saisir du contenu et générer le site.


[1]

Dropbox est un service de stockage de fichiers sur le cloud. Vous pouvez obtenir un compte gratuitement d’un maximum de de 2Go de stockage. Vos fichiers seront dans ce cas placés dans le dossier ‘Public’.

A noter : L’hebergement via Dropbox ne vous permet pas d’avoir un nom de domaine propre.

[2]

Pourquoi préfixer la chaine de texte avec ‘u’ ?

Sur les version 2.x de python, l’encodage par défaut n’est pas unicode. Il faut donc prévenir que la chaine que vous allez utiliser l’est. Notez que ceci n’est plus obligatoire depuis python 3.x puisque tous les fichiers sont considérés par défaut en UTF-8.

[3]Ici nous utilisons le nom de dossier plugins mais bien enetendus celà dépend du nom que vous avez donné au dossier téléchargé ou cloné.

Commentaires