A Python robot that edits Wikipedia and interacts with people over IRC https://en.wikipedia.org/wiki/User:EarwigBot
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

setup.rst 1.3 KiB

12 years ago
12 years ago
12 years ago
12345678910111213141516171819202122232425262728
  1. Setup
  2. =====
  3. The bot stores its data in a "working directory", including its config file and
  4. databases. This is also the location where you will place custom IRC commands
  5. and bot tasks, which will be explained later. It doesn't matter where this
  6. directory is, as long as the bot can write to it.
  7. Start the bot with :command:`earwigbot path/to/working/dir`, or just
  8. :command:`earwigbot` if the working directory is the current directory. It will
  9. notice that no :file:`config.yml` file exists and take you through the setup
  10. process.
  11. There is currently no way to edit the :file:`config.yml` file from within the
  12. bot after it has been created, but YAML is a very straightforward format, so
  13. you should be able to make any necessary changes yourself. Check out the
  14. `explanation of YAML`_ on Wikipedia for help.
  15. After setup, the bot will start. This means it will connect to the IRC servers
  16. it has been configured for, schedule bot tasks to run at specific times, and
  17. then wait for instructions (as commands on IRC). For a list of commands, say
  18. "``!help``" (commands are messages prefixed with an exclamation mark).
  19. You can stop the bot at any time with :kbd:`Control-c`, same as you stop a
  20. normal Python program, and it will try to exit safely. You can also use the
  21. "``!quit``" command on IRC.
  22. .. _explanation of YAML: http://en.wikipedia.org/wiki/YAML