rcarmo / yaki Goto Github PK

View Code? Open in Web Editor NEW

55.0 5.0 8.0 3.79 MB

A filesystem based wiki

Home Page: http://the.taoofmac.com/space/projects/Yaki

Python 97.00% JavaScript 0.92% Erlang 0.02% Shell 0.01% C 1.71% Perl 0.34%

yaki's Introduction

Yaki - A fast, powerful filesystem-based wiki

Deprecation Warning:

This is being superseded by yaki-tng, which is a nearly complete re-write atop Bottle.

About

This was the second public release of Yaki (the first was in Google Code, and is long obsolete).

Yaki is a filesystem-based wiki that is used as the underpinnings of The Tao of Mac (and a few other sites that started using the initial release).

Features

100% pure Python, with extensive UTF-8 support
Entirely self-hosting, running atop a modified Snakelets application framework
Completely filesystem-based (pages are stored on a directory structure, not a database)
Heavily optimized HTTP processing:
- Pages are pre-processed to HTML
- HTML and other internal info are stored in a single-file cache, a la Haystack
- Everything is served via sendfile(2) calls whenever possible
- Uses every HTTP caching trick in the book to minimize actual page hits
Completely markup-agnostic - all the internal processing relies on Beautiful Soup, and it ships with support for:
- raw HTML
- Textile
- Markdown
Any markup engine that generates HTML can be added, and markup can be defined on a site-wide or page-per-page basis
Has all the usual features, like:
- Page aliasing
- Interwiki
- RecentChanges
- etc.
Has a number of unusual Bliki features, like a blog-like home page, linkblog support, and the SeeAlso table at the bottom of each page.
Supports full-text indexing and search using Whoosh

Requirements

Python 2.6 (2.7 will work just as well, and 2.5 may work with minimal tweaks)
That's it.

License

Yaki is released under the MIT License. Some third-party libraries in the userlibs folder are licensed differently and are included merely to ease deployment.

The Twitter Bootstrap HTML+CSS which is used as the default theme is licensed under the Apache License v2.0.

Credits

The Snakelets application server was originally developed by Irmen de Jong, and as far as I know this is the only publicly maintained version of it.

yaki's People

Contributors

Stargazers

Watchers

Forkers

lhagan oier 20after4 pfig fsroque anotherjesse adamhorner hometheateroperatingsystem

yaki's Issues

Documentation

There is an utter lack of documentation.

Documentation shall be considered finished (if ever) when the following are available:

A README
A deployment guide
An updated Snakelets manual (for the brave developers)
Engine documentation
Plugin documentation
Templating documentation

monitor.py: ImportError: No module named serv

The monitor.py script that 'ships' in the current version can't import serv (which is what 'app.py' used to be called?). We can import app as serv, but some (recent?) refactoring of the assignment in app.py mean this doesn't work either (AttributeError: 'module' object has no attribute 'HTTPD_PORT'). Unfortunately my Python is too weak to troubleshoot much further than this...

Getting started...

I've downloaded, run yaki/app.py, and navigated to "localhost:9090" as directed... but I just get this error message:

WebAppContext' object has no attribute 'dumbagents'
"/space" gave the following message:

  File "/home/symon/Downloads/yaki/snakeserver/webapp.py", line 619, in run_snakelet
    snake.serve(req, resp)          # <------ the actual call to the snakelet!
  File "/home/symon/Downloads/yaki/userlibs/yaki/Engine.py", line 294, in serve
    page = self.getPage(request, response)
  File "/home/symon/Downloads/yaki/userlibs/yaki/Engine.py", line 491, in getPage
    m = ac.dumbagents.match(request.getUserAgent())
AttributeError: 'WebAppContext' object has no attribute 'dumbagents'

Could you offer any suggestions?

Footnotes link to full page path (instead of internal link)

For example:

<a href="/space/blog/2012/03/17/1802#fn:1" rel="/space/blog/2012/03/17/1802#fn:1" class="anchor" title="link to fn:1 in this page">1</a>

Should be:

<a href="#fn:1" rel="/space/blog/2012/03/17/1802#fn:1" class="anchor" title="link to fn:1 in this page">1</a>

This means an unnecessary page load for the user and also prevents things like Footnotify from working properly.

TypeError on python 2.7 / Windows

cloned the repo, installed python (http://www.python.org/ftp/python/2.7.2/python-2.7.2.msi), ran the application and I get this error while browser is stuck on http://localhost:9090/p/start, (error 503, server restarting)

D:\tmp\Yaki\yaki>app.py
Wed Apr 11 16:27:59 2012 GMT Starting server on 127.0.0.1:9090 (9090)
[18:28:00,server] Server starting...
[18:28:00,server] Exception in thread Thread-2:
Traceback (most recent call last):
File "D:\dev\tools\Python27\lib\threading.py", line 552, in __bootstrap_inner
self.run()
File "D:\tmp\Yaki\yaki\userlibs\yaki\Indexer.py", line 94, in run
self.pagescan() # Do preliminary scanning
File "D:\tmp\Yaki\yaki\userlibs\yaki\Indexer.py", line 334, in pagescan
self.indexable.sort(lambda x, y: self.allpages[y]-self.allpages[x])
TypeError: comparison function must return int, not long
[18:28:00,server] Exception in thread Thread-4:
Traceback (most recent call last):
File "D:\dev\tools\Python27\lib\threading.py", line 552, in __bootstrap_inner
self.run()
File "D:\tmp\Yaki\yaki\userlibs\yaki\Indexer.py", line 94, in run
self.pagescan() # Do preliminary scanning
File "D:\tmp\Yaki\yaki\userlibs\yaki\Indexer.py", line 334, in pagescan
self.indexable.sort(lambda x, y: self.allpages[y]-self.allpages[x])
TypeError: comparison function must return int, not long
[18:28:00,server] Serving requests.

Redirect Loop on meta/EmptyPage

Keeps looping to meta/EmstarttyPage and back. Could be from the latest pull or the Snakelets redirect mechanism.