Support virtualenv. Update README.
This commit is contained in:
parent
6c3be38300
commit
3c366bb5e2
2 changed files with 33 additions and 3 deletions
27
README.md
27
README.md
|
|
@ -3,8 +3,29 @@ LolBot
|
||||||
|
|
||||||
A naff IRC bot I rattled off in a hurry once, for folks stuck behind censor
|
A naff IRC bot I rattled off in a hurry once, for folks stuck behind censor
|
||||||
walls at work. Logs a channel and collects up all the URLs for later.
|
walls at work. Logs a channel and collects up all the URLs for later.
|
||||||
|
It was refactored for Twisted in 2011, then again to use pypi irc in 2015.
|
||||||
Rewritten based on Twisted for now. One day they might port Twisted to Python 3.
|
|
||||||
|
|
||||||
Has recently grown a quiz feature based on MoxQuizz, which might actually turn
|
Has recently grown a quiz feature based on MoxQuizz, which might actually turn
|
||||||
into something useful one day.
|
into something useful one day.
|
||||||
|
|
||||||
|
Installation
|
||||||
|
------------
|
||||||
|
|
||||||
|
To get started, set up a Python virtual environment, and install the stuff in
|
||||||
|
`requirements.txt`.
|
||||||
|
|
||||||
|
apt-get install python-virtualenv
|
||||||
|
|
||||||
|
Clone this git repository, and in the directory:
|
||||||
|
|
||||||
|
virtualenv env
|
||||||
|
env/bin/pip install -r requirements.txt
|
||||||
|
|
||||||
|
Then you can run the bot like so:
|
||||||
|
|
||||||
|
env/bin/python lolbot.py <server[:port]> <channel> <nickname> <db>
|
||||||
|
|
||||||
|
Development
|
||||||
|
-----------
|
||||||
|
|
||||||
|
Patches welcome! Development currently happens on the New Zealand Open Source
|
||||||
|
Society [GitLab](https://git.nzoss.org.nz/moxquizz-fans/lolbot).
|
||||||
|
|
|
||||||
9
requirements.txt
Normal file
9
requirements.txt
Normal file
|
|
@ -0,0 +1,9 @@
|
||||||
|
SQLAlchemy==1.0.9
|
||||||
|
argparse==1.2.1
|
||||||
|
irc==11.0.1
|
||||||
|
jaraco.timing==1.1.5
|
||||||
|
jaraco.util==10.6
|
||||||
|
mechanize==0.2.5
|
||||||
|
more-itertools==2.2
|
||||||
|
six==1.10.0
|
||||||
|
wsgiref==0.1.2
|
||||||
Loading…
Add table
Reference in a new issue