PyDoc szerver

Könnyű ujjgyakorlatként összeütöttem egy wrapper daemon-t a Python pydoc modul hasonló nevű függvényéhez. Ez lényegében egy webszervert hoz létre (alapértelmezés szerint a 7464-es TCP porton), melyen keresztül megtekinthetők a rendszerre feltelepített modulok dokumentációja (amennyiben persze vette a készítő a fáradságot a docstringek elhelyezéséhez).

A program jelenleg innen szedegethető

Telepítése roppant egyszerű, egy make install kiadása után a /usr/local/sbin/ mappában egy pydocserver nevű fűjl landol. Ehhez kell egy disztribúciófüggő init szkriptet legyártani.
A szervíz maga teljesértékű démon, nem igényel semmilyen beavatkozást.

2 mappa meglétét feltételezi, a /var/run és a /var/log mappákét. Az egyik helyre a PID-et menti (/var/run/pydocserver.pid), a másik helyre naplóz (/var/log/pydocserver.log).

Várok bugreportokat, ötleteket, tesztelőket itt kommentben vagy pü.

Jó munkát!

Hozzászólások

ez mennyivel tud többet mint a 'pydoc -g' utasítás? tényleg kíváncsi vagyok...
--
ubuntu linux member

Hát, teljesen más. Nem ad GUI frontendet, hanem egy kvázi webszerverként üzemel. Mivel nekem úgyis nyitva van pár böngészőablak, ott elfér, de ha már a GUI-s frontend lenne az már zavarna.

Azonkívül ezt olyan gépekről is el lehet érni, amin nics python installálva, és esetleg net sincs.

Amúgy a rövid válasz ennyi: mert yobb.

PS: Lemaradt a cikkből, hogy böngészőből kell megnyitni a http://127.0.0.1:7464 címet, hogy használatba vehesd.

Egyrészt up, másrészt kiadás előtt toporog a 0.3 verzió. Gyak. 0-ról újraírva, támogatja az exceptionök elkapását, rendesen elindul-leáll, ha valami extrém kritikus baja van, a syslogba sikolt. Ha el tudja érni a logfájlját, és engedélyeztük a logfájl használatát, akkor a logfájlba is beletörli a könnyeit.

Egy todo van még hátra, a pidfájl elpucolása leállításkor, erre valami signal handler-t kell majd tenni, kissé fázok tőle. Ha az meglesz, akkor késznek nyilváníttatik.

Érdemes README-t olvasgatni, hasznos olvasmány.