Skip to content
Snippets Groups Projects
Commit 9b0ed919 authored by Svetlana Tkachenko's avatar Svetlana Tkachenko
Browse files

Add documentation. Add .gitignore

parent d89b5cd4
No related branches found
No related tags found
No related merge requests found
INSTALL 0 → 100644
OS Support
- Linux (tested)
- Mac OS X
- Others
Requirements
- Python 2.5.2 or later
- argparse module (in P.2.7+)
- No support for Python 3 yet!
Install
./guppy-start
Answer questions.
./guppy-start
README 0 → 100644
guppy is a modular IRC bot. We would like to provide an easy to use alternative to other currently available IRC bots. The API makes new modules easier to add.. The project is in beta.
Features
[admin] Keep a list of bot users and passwords. Bot administrators can send raw commands to server and add other administrators.
[fact] Keep a list of factoids. Everyone can change them. The dictionary is located at ~/.gpy/dict .
[calc] Perform basic calculations on a Reverse Polish Notation Input. Should be enough for most operations needed. The implementation is pretty straightforward and secure; eval() isn't used.
[--makeconf] Keep a configuration file at ~/.guppy/main.cfg . It's created basing on your answers on first run, and you can run gpy-start with the --makeconf switch to edit the current configuration.
Logs. Keep a log of queries to the bot and any errors encountered.
[web] Perform some web functions
Google translate
Google web search
duckduckgo.com infoboxes search
dns lookup
youtube video information lookup by URL or id
Files
INSTALL - how to install
docs/ - how stuff works
TODO - planned features
TODO 0 → 100644
Milestone: 0.4
[ ] admin' module in sqlite3 users db
[ ] Python 3 support
[ ] Google calculator module ( - Wind: 8 kts (9.2 mph) .. calc 8 kts in beaufort)
[ ] Google image search module
[ ] Get the title of a link module
[ ] timezones module
[ ] dictionary word lookup module
[ ] weather module
[ ] wiktionary/wikipedia lookup module
Modules
The modules make use of __doc__ feature and class inheritance - you just need to write the functions and their documentation, but don't need to write anything for the bot to send the documentation when the help is requested. You can just read a few existing modules and make your own similarly.
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment