mwillsey / crossbot

A slackbot to compete on mini crosswords (or any other daily challenge).

crossbot

A Slack bot to make you really competitive on the New York Times mini crossword.

Developing

Clone the repo and run make test to ensure everything works.

There are a few useful make targets that are worth knowing about:

• make venv will install a virtualenv for with all the dependencies you'll need.
• make clean will destroy the virtualenv; use this to update/clean the dependencies
• make fmt runs the yapf code formatter
• make check_fmt checks the formatting using yapf
• make lint[_all_] runs the pylint linter (lint_all is very strict)
• make test runs the tests
• make check runs the formatting check, linter, and tests. This is what the CI runs.
• make deploy actually runs the code and not the debug server. You probably don't wanna do this.