TechLife devBlog

Pelican - generator statycznych stron

Kodowanie, Python 11 listopada 2014 23:19

Opuszczając dawno wymarły Jogger, zastanawiałem się gdzie przerzucić mojego bloga. Niestety drugiego takiego miejsca nie ma i pewnie już nie będzie :'-( IMHO Jogger zaczął umierać w momencie kiedy Sparrow, nie zgodził się na uwolnienie kodu o co prosiła społeczność.

Anyway, do wyboru jest bardzo niewiele. Dodatkowo chciałem:

  • zaimportować dotychczasowe treści
  • nie przekazywać nikomu prawa do dysponowania generowanymi przeze mnie treściami (Facebook, Google Plus)
  • nie być ograniczonym różnymi płatnymi usługami jak np. płatne podpięcie domeny (WordPress.com)
  • mieć do dyspozycji składnię w której można ładnie prezentować kod, i nie męczyć się z HTML-em (bez TinyMCE ani pochodnych).

W końcu wpadłem na notkę 10 Open Source Blogging Platforms for Developers i zaskoczyło mnie bardzo elastyczne zastosowanie dla Pelicana - generatora statycznych stron.

Z grubsza Pelican jest prostą aplikacją napisaną w Pythonie, która potrafi z plików .md (Markdown), .rst (reStructuredText) i .html wygenerować cały blog, tak jak to robią inne systemy dynamicznie generujące treść. Różnica jest tylko taka, że Pelican robi to tylko raz, wtedy kiedy dodawana jest nowa treść. Zalety są takie, że wygenerowana strona to zwykłe pliki HTML + JS, więc od jej hostowania wystarczy najprostszy serwer www, nie musi nawet posiadać obsługi PHP czy innego Pythona. Nie potrzeba też żądnej bazy danych.

Wystarczy nam nawet typowy hosting z lat '90 z dostępem przez FTP. Oczywiście są też Pelican wspiera również czasy współczesne, czyli SSH, Amazonowy S3, Dropbox-a, GitHub-a czy rackspace.

Instalacja i konfiguracja

Instalacja jest banalnie prosta, najlepiej zrobić sobie wirtualne środowisko i w nim zainstalować wymagane pakiety.

:::sh
$ pip install pelican markdown

Później odpalamy prosty konfigurator:

:::sh
$ pelican-quickstart

Całą resztę załatwiamy przez edycji pliku pelicanconf.py. Pełną listę opcji znajdziecie w dokumentacji - a jest ich tam dość sporo.

Używanie

Generalna zasada jest taka, w katalogu content umieszczamy właściwe treści, z których później wygenerowana zostanie strona, której pliki znajdziemy w katalogu output. Oczywiście nazwy katalogów można również skonfigurować.

Obojętnie który z formatów wybierzemy (.md, .rst czy .html) musi on zawierać metadane. Np. tytuł, data, kategoria, tagi, slug, autorzy. Żeby jednak było łatwiej to jedynym wymaganym do wygenerowania strony atrybutem jest tytuł.

Przykład z dokumentacji dla Markdown-a:

:::text
Title: My super title
Date: 2010-12-03 10:20
Modified: 2010-12-05 19:30
Category: Python
Tags: pelican, publishing
Slug: my-super-post
Authors: Alexis Metaireau, Conan Doyle
Summary: Short version for index and feeds

This is the content of my super blog post.

Po stworzeniu pliku wystarczy nam komenda

:::sh
pelican content

i już w katalogu output powinna czekać na nas gotowa do przeglądania strona.

Oczywiście każdy lubi na bieżąco oglądać swoje postępy dlatego, żeby nie generować co chwilę całej strony powstał server developerski - develop_server.sh. Wystarczy go odpalić:

:::sh
$ ./develop_server.sh start

i od tech wili będzie on śledził wszystkie zmiany w katalogu content i automatycznie generował pliki związany z treścią, która uległa zmianie a całość podglądać możemy wstukując w przeglądarce adres: 127.0.0.1:8001.

Publikacja treści

Przed wypchnięciem treści na właściwy serwer należy skonfigurować jeszcze dwa pliki. W pliku publishconf.py możemy przeciążyć zmienne z pelicanconf.py np. podać właściwy adres url strony (zmienna SITEURL). Drugim plikiem jest Makefile gdzie ustawiamy dostępy do naszego serwera (FTP, SSH czy coś innego).

Przykład konfiguracji dla FTP:

:::ini
FTP_HOST=localhost
FTP_USER=anonymous
FTP_TARGET_DIR=/

Po skonfigurowaniu obu plików wydajemy komendę odpowiadającą sposobowi transportu naszych plików na serwer. Czyli np.

:::sh
$ make ssh_upload

Czy przy wrzucaniu plików przez FTP:

:::sh
$ make ftp_upload

I to wszystko, gotowa strona ląduje w odpowiednim miejscu gotowa do oglądania.

Podsumowanie

Jak widać za pomocą Palicana udało mi się niemal identycznie odtworzyć Joggera pomimo, że są to zwykłe pliki HTML + JS. Wszystko dzięki bardzo elastycznemu systemowi szablonów (Jinja) oraz systemowi pluginów, który dokłada nam dodatkowe możliwości tj. generowanie mapy strony, dodawanie systemu komentarzy czy dodawanie galerii. Całość jest bardzo konfigurowalna, udało mi się nawet odtworzyć strukturę url-i jaką miałem na Joggerze, dzięki czemu linki do wpisów, które znaleźć można przez Googla nadal pozostaną aktualne.

Całą stronę można trzymać w repozytorium, np. na GitHubie, dzięki czemu backup i historię mamy załatwioną. Swoją drogą ciekawy byłby serwis generowany przez Pelicana, gdzie własne autorzy artykuły zgłaszaliby przez pull requesta :-)

Linki do pooglądania:



Komentarze