2013-08-25 15:22:06 -04:00
|
|
|
# phenny
|
2013-08-25 15:28:30 -04:00
|
|
|
[](https://travis-ci.org/mutantmonkey/phenny)
|
2011-09-22 15:44:13 -04:00
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
This is phenny, a Python IRC bot. Originally written by Sean B. Palmer, it has
|
|
|
|
|
been ported to Python3 for use in #vtluug on OFTC.
|
2011-09-22 18:15:42 -04:00
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
This version comes with many new modules, IPv6 support, TLS support, and unit
|
|
|
|
|
tests.
|
2011-09-22 18:15:42 -04:00
|
|
|
|
|
|
|
|
Compatibility with existing phenny modules has been mostly retained, but they
|
2012-06-02 00:46:40 -04:00
|
|
|
will need to be updated to run on Python3 if they do not already. All of the
|
2013-08-25 15:22:06 -04:00
|
|
|
core modules have been ported, removed, or replaced.
|
2011-09-22 15:44:13 -04:00
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
## Requirements
|
2013-06-09 01:27:24 -04:00
|
|
|
* Python 3.2+
|
|
|
|
|
* [python-requests](http://docs.python-requests.org/en/latest/)
|
|
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
## 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
|
2011-09-22 15:44:13 -04:00
|
|
|
|
|
|
|
|
Enjoy!
|
|
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
## Testing
|
2012-06-02 00:37:08 -04:00
|
|
|
You will need the Python3 versions of `python-nose` and `python-mock`. To run
|
2012-06-02 00:46:40 -04:00
|
|
|
the tests, simply run `nosetests3`.
|
2012-05-31 00:22:52 -04:00
|
|
|
|
2013-08-25 15:22:06 -04:00
|
|
|
## Authors
|
2011-09-22 18:15:42 -04:00
|
|
|
* Sean B. Palmer, http://inamidst.com/sbp/
|
|
|
|
|
* mutantmonkey, http://mutantmonkey.in
|
