Skip to content

quickstart.md

Latest commit

 

History

History
85 lines (62 loc) · 2.6 KB

quickstart.md

File metadata and controls

85 lines (62 loc) · 2.6 KB

Quickstart

Installation

You'll need Python 2.7, and the tools Virtualenv and Pip are highly recommended.

Once you've got that set up, you should create a virtualenv to work in, and activate it. This keeps Hamper's libraries isolated from the rest of your system, which helps avoid version conflicts. Run these commands in the git repo you cloned.

$ virtualenv venv
$ source venv/bin/activate

Note that on systems like Arch Linux, where Python 3 is the default, you will have to specificy that you want to use Python 2. In particular, you should use the command virtualenv2 instead of virtualenv. This will create a Python 2 virtualenv, so you would have to worry about it for the rest of this guide.

To install the requirements, run

$ pip install -r requirements.txt

Tests

A good way to make sure you have all the requirements is by running the tests. The tests don't rely on any confifguration, so you can run them now. To run the tests run the command

$ trial hamper

If you get "command not found" you may have to give a better path to trial. Try

$ venv/bin/trial hamper

Configuration

You'll need to configure hamper so that your instance of Hamper is a unique snow flake (like all the rest). Configuration is stored in a file named hamper.conf. You'll notice it doesn't exist yet, but there is a template, hamper.conf.dist. Copy that file, name the copy hamper.conf, and edit it to reflect your desired set up.

In particular, you problably want to change the nickname, server, port, channels, and plugins. These should be pretty straight forward, but if you want more details, read the configuration docs.

Running

The main entry point for Hamper is scripts/hamper, which imports the bot, tries to set up the Python path if needed, and runs the main function. You will need to tell Python where to find packages for now.

$ export PYTHONPATH=.
$ scripts/hamper

If all you configured the bot correctly, it should start up, load any listed plugins, connect to the irc server, and join the specified channels, where you can start interacting with it. Yay!

For more information about where to go from here, see the docs about adminstration or plugin development, or if you want to deploy Hamper in a little more permanent way, check out the deployment docs for Heroku or Docker