phenny-1/README.md

30 lines
837 B
Markdown
Raw Normal View History

phenny
======
This is an experimental port of phenny, a Python IRC bot, to Python3. It is
currently fairly stable, but it has not been as well-tested as the original.
2011-09-22 18:15:42 -04:00
2012-01-03 14:30:14 -05:00
Support for IPv6 and SSL has been added. It appears that SSL support requires
Python 3.2.
2011-09-22 18:15:42 -04:00
Compatibility with existing phenny modules has been mostly retained, but they
will need to be updated to run on Python3 if they do not already.
Installation
------------
2011-09-22 18:15:42 -04:00
1. Run `./phenny` - this creates a default config file
2011-09-22 18:16:22 -04:00
2. Edit `~/.phenny/default.py`
2011-09-22 18:15:42 -04:00
3. Run `./phenny` - this now runs phenny with your settings
Enjoy!
Testing
-------
You will need `python-nose` and `python-mock`. To run the test, simply run
`nosetests` or `nosetests3`, depending on your distribution.
2011-09-22 18:15:42 -04:00
Authors
-------
* Sean B. Palmer, http://inamidst.com/sbp/
* mutantmonkey, http://mutantmonkey.in