Fix opening log directory
[pyrook:pyrook.git] / pyrook_info.py
1 name = "PyRook"
2
3 short_description = "A standalone client for RookChat written in Python and Qt"
4
5 long_description = """PyRook aims to provide a platform-independent standalone [RookChat](http://rinkworks.com/rookchat) client with feature parity with the standard web interface, plus additional features such as highlighting on your username and local logging. By default it connects to [RinkChat](http://rinkworks.com/rinkchat), [RinkWorks](http://rinkworks.com)' installation of RookChat.
6
7 Comments, bugs, etc may be memoed to Sentynel or #pyrook on RinkChat, or emailed to me.
8
9 PyRook's source code is public domain. The source code, hosted on [Gitorious](http://www.gitorious.org), can be accessed [here](https://gitorious.org/pyrook/pyrook)."""
10
11 priority = 0
12
13 categories = "misc"
14
15 requirements = """For Windows users who don't use Python otherwise, there is a standalone version which includes all required dependencies and spellcheck support.
16
17 For the source versions, you will need: Python 2.6 or 2.7, the Python interpreter. PySide v1.0, the Python bindings for Qt, the graphics toolkit (or alternatively the unofficial PyQt bindings, but you will have to adapt the imports, and this is unsupported). lxml, the HTML parser.
18
19 Optionally: pyenchant, Python bindings for the Enchant spellcheck library.
20
21 Optionally, for ops: [pygeoip](http://pypi.python.org/pypi/pygeoip), Python GeoIP handler, and a GeoIP database, either [country level](https://www.maxmind.com/app/geolitecountry) (recommended) or [region level](https://www.maxmind.com/app/geolitecity) (much larger and not much more useful; region code -> name mapping is [here](https://www.maxmind.com/app/fips10_4)). The database should be unzipped, named GeoIP.dat, and placed in PyRook's start directory. As with icons, it can be deleted after being run once.
22
23 ### Windows
24 Python 2.6 or 2.7 (recommended) from [http://www.python.org/download/](http://www.python.org/download/). Either the 32 or 64 bit versions will work, but you must ensure that the PySide and lxml libraries you download are for the same architecture, and you must have a 64 bit version of Windows to use the 64 bit version. pyenchant is not packaged for 64 bit Python. If in doubt use 32 bit.
25
26 PySide bindings for your Python version from [http://developer.qt.nokia.com/wiki/PySide_Binaries_Windows](http://developer.qt.nokia.com/wiki/PySide_Binaries_Windows).
27
28 lxml parser for your Python version, .exe installer recommended, from [http://pypi.python.org/pypi/lxml/2.3#downloads](http://pypi.python.org/pypi/lxml/2.3#downloads).
29
30 Optionally, pyenchant, .exe installer recommended, from [http://pypi.python.org/pypi/pyenchant](http://pypi.python.org/pypi/pyenchant).
31
32 Optionally, for ops, pygeoip, available only in source form from [http://pypi.python.org/pypi/pygeoip](http://pypi.python.org/pypi/pygeoip) - install manually or using easy_install or pip.
33
34 ### Linux
35 All required packages should be available from your distribution's package manager. On *ubuntu, install python-pyside, python-lxml and python-enchant. All other dependencies will be pulled in automatically if necessary.
36
37 If you want pygeoip, it may not be packaged, and will need to be installed from the [PyPI](http://pypi.python.org/pypi/pygeoip) page, manually or using easy_install or pip. The C GeoIP library may be packaged (e.g. as python-geoip), but this is not supported due to segfaults in testing.
38
39 ### Mac OSX
40 All dependencies are available for Mac, but you will need to search the download sites yourself for a set of correctly linked versions. They may also be available from Macports or Homebrew."""
41
42 versions = [
43 {"name":"Initial Release", "major":0, "minor":1, "point":0, "description":"First Qt based release. Should implement all basic functions, and most functions from the old wxWidgets based version."},
44 {"major":0, "minor":1, "point":1, "description":"Lots of minor fixes: /purge, quit keyboard shortcut on Windows, open external links, sending messages with non-ASCII characters, more reliable chatstream merging, more reliable scrolling down on new message."},
45 {"major":0, "minor":1, "point":2, "description":"More fixes: smileys, extraneous comma in some room names, purging, XML syntax error handling. Crash prevention when displaying room list and room with bots and no topic visible (though user list still isn't displayed in this case). Possible fix for intermittent crash on user list load."},
46 {"major":0, "minor":1, "point":3, "description":"Features: highfive command, glow on input box when /msg targets selected. Fixes: URL handling (internal links, external links with special characters, links on PySide v1.0.3), userlist request crash (probably - please report if you still get it), parsing improvements, sane application exiting (individual rooms can be left, doesn't halt system shutdown, etc), room list window topic wrapping, misc cleanup."},
47 {"major":0, "minor":2, "point":0, "description":"Changes since v0.1.3 include a better room join dialogue which will display any combination of users, topic and bots and has new room buttons; window alerts (taskbar highlight etc) on new messages or messages mentioning particular words; a permanent fix for chatstream merging and timestamp related bugs; and lots of miscellaneous fixes and tweaks."},
48 {"major":0, "minor":2, "point":1, "description":"Configurable font size, improvements to highlighting handling, RookChat options, memos, help etc in menus, and fixes to room join dialogue for non-English languages."},
49 {"major":0, "minor":2, "point":2, "description":"Remember username/password, command line options for user/pass/server, embedded QtWebKit tabs for internal RookChat links, logo/window icon, an internal debug log window, and more tweaks and fixes."},
50 {"major":0, "minor":2, "point":3, "description":"Tweaks: skip the login box if a username and password are remembered, and allow remembering the size of the room join dialogue."},
51 {"major":0, "minor":2, "point":4, "description":"Tweaks: Fix external links from web tabs, and alter the logo for better display against dark backgrounds."},
52 {"major":0, "minor":2, "point":5, "description":"Really boring: Fix encoding-related issues, including broken room join dialogue with non-ASCII topics and send/receive inconsistencies for Windows-1252 encoded characters such as smart quotes."},
53 {"major":0, "minor":2, "point":6, "description":"Add automatic focus on the input box in a number of cases, many debug improvements including exceptions and a raw HTML view, a fix for a Windows issue with the chatstream dying, and some minor fixes."},
54 {"major":0, "minor":3, "point":0, "description":"New features since v0.2.6 include: optional spellcheck; greatly improved alert configurability and accuracy, including different settings when away; optional reminder of away status; and optional GeoIP lookups for op use. Fixes include: a Windows issue causing occasional line loss; correct result from right click -> Copy Link Location; some WebTab behaviour such as refresh and copy (on Windows); and other miscellaneous fixes."},
55 {"major":0, "minor":3, "point":1, "description":"Add the ability to /purge without losing the entire backlog. Bug fixes including size and behaviour of input box, away state tracking, the /msg target box behaviour if the targeted user leaves, and the selection clipboard on Linux."},
56 {"major":0, "minor":3, "point":2, "description":"Adds logging functionality and the option to display timestamps in the local timezone. Fixes the improved purge handling and numerous minor glitches, and tidies the settings dialogue a bit."},
57 {"major":0, "minor":3, "point":3, "description":"Adds option to split private messages into separate tabs. Minor speed improvement to chatstream parsing, and a couple of minor fixes."},
58 {"major":0, "minor":3, "point":4, "description":"Minor bugfixes. Removal of unused and broken tab detachment feature. Tools to distribute standalone Windows package."},
59 {"major":0, "minor":3, "point":5, "description":"Adds a find function, detection of URLs in the topic, and the ability to show large versions of images in bot games. Improves message tab handling of bots and status changes. Fixes numerous minor issues including parsing and logging failures and incorrect spellcheck tokeniser behaviour."},
60 {"major":0, "minor":3, "point":6, "description":"Minor fixes: Userlist parse failure in rare cases, CPU eating bug on dead network connection."},
61 {"major":0, "minor":3, "point":7, "description":"Adds support for proxies. Fixes errors with Qt 4.8."},
62 {"major":0, "minor":3, "point":8, "description":"Add notification on network connectivity issues and ability to scroll back through sent message history. Fix a chatstream refreshing issue after being kicked."},
63 {"major":0, "minor":3, "point":9, "description":"Fix showing timestamps in local time and some odd topic link behaviour. Improve detection of network errors."},
64 {"major":0, "minor":3, "point":10, "description":"Fix a crash displaying the userlist with non-ASCII labels."},
65 {"major":0, "minor":3, "point":11, "description":"Adds a choice of log rotation frequency and a timestamp toggle for users who normally have timestamps off. Improves appearance of web tabs. Fixes bugs with long format timestamps in local time and userlist IP lookup."},
66 {"major":0, "minor":3, "point":12, "description":"Adds shortcuts for timestamp toggling and focusing the input bar. Various fixes to parsing, timestamp toggling, and more."},
67 ]