cpssd-students / steely

to install

$ git clone this
$ pip3 install --user -r requirements.txt
or, if you're in a new py3 virtualenv
$ pip install -r requirements.txt

to run

$ mv config.py.sample config.py
$ edit config.py
$ python3 steelybot.py

(config.py is in .gitignore)

to run tests

$ make test

or simply...

$ nosetest

If the tests are failing to import, you probably aren't in the virtualenv.

how to write help for your commands

Throw a doc string in the top of the plugin.

If it's short just make it one line but if its thicc and has subcommands check steely/plugins/linden for an example.

todo

• async lastfm plugin stuff
• trigger decorators for plugins, not just main()
• izaakf's secret idea

thanks (related to the cpssd steely instance)

• to CianLR for bailing me out of DO bills to get the dbs/logs backs
• to devoxel for hosting after the bailout
• the contributors below

credits