Skip to content
This repository has been archived by the owner on Jul 13, 2023. It is now read-only.

Latest commit

 

History

History
20 lines (15 loc) · 963 Bytes

README.md

File metadata and controls

20 lines (15 loc) · 963 Bytes

crossbot

Build Status

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.