Repo maintenance

- Remove .coveragerc file (be explicit in pytest commmand)
- Update .travis.yml to contain make commands only (reduce dup)
- Simplify pytest.ini
- Clean up docs/conf.py (mock not used)
- Clean up State
- Specific versions in requirements.txt
- Move tests from protowhat/tests/ to tests/

.travis.yml

@@ -1,10 +1,11 @@
 language: python
 python:
 - '3.5'
-install:
-- pip install -e .
-- pip install -r requirements.txt
+
+install: make install
+
 script: make test
+
 deploy:
   provider: pypi
   user: machow

Makefile

@@ -1,11 +1,15 @@
 # Controls
-.PHONY : commands clean test
+.PHONY : commands install clean test
 all : commands
 
 ## commands : show all commands.
 commands :
 	@grep -h -E '^##' Makefile | sed -e 's/## //g'
 
+install:
+	pip install -e .
+	pip install -r requirements.txt
+
 ## test     : run tests.
 test :
 	pytest --cov=protowhat

README.md

@@ -4,17 +4,22 @@
 [![codecov](https://codecov.io/gh/datacamp/protowhat/branch/master/graph/badge.svg)](https://codecov.io/gh/datacamp/protowhat)
 [![PyPI version](https://badge.fury.io/py/protowhat.svg)](https://badge.fury.io/py/protowhat)
 
+`protowhat` is a utility package required by `shellwhat` and `sqlwhat` packages, used for writing Submission Correctness Tests SCTs for interactive Shell and SQL exercises on DataCamp. It contains shared functionality related to SCT syntax, selectors and state manipulation.
+
+- If you are new to teaching on DataCamp, check out https://authoring.datacamp.com.
+- If you want to learn what SCTs are and how they work, visit https://authoring.datacamp.com/courses/sct.html.
+- For a deep dive in `protowhat`, consult https://protowhat.readthedocs.io.
+
 ## Installation
 
 ```
-pip install protowhat
+pip install protowhat   # install from pypi
+make install            # install from source
 ```
 
 ## Testing
 
-From the base directory..
-
 ```
 pip install -e .
-py.test
+pytest
 ```

docs/conf.py

@@ -16,7 +16,6 @@
 # Mock heavy duty pythonwhat dependencies for autodoc
 import os
 import sys
-from unittest import mock
 
 # If extensions (or modules to document with autodoc) are in another directory,
 # add these directories to sys.path here. If the directory is relative to the

protowhat/State.py

@@ -7,12 +7,6 @@ def __init__(self):
 
     def parse(self, *args, **kwargs): return self.ParseError()
 
-class Dispatcher:
-    @classmethod
-    def from_dialect(cls):
-        # TODO return something with a parse method
-        return DummyParser()
-
 class State:
     def __init__(self,
                  student_code,
@@ -46,8 +40,7 @@ def __init__(self,
         self._child_params = inspect.signature(State.__init__).parameters
 
     def get_dispatcher(self):
-        # MCE doesn't always have connection - fallback on postgresql
-        return Dispatcher.from_dialect()
+        return DummyParser()
 
     def get_ast_path(self):
         rev_checks = filter(lambda x: x['type'] in ['check_field', 'check_node'], reversed(self.history))

pytest.ini

@@ -1,2 +1,2 @@
 [pytest]
-testpaths = protowhat/tests
+testpaths = tests

requirements.txt

@@ -1,4 +1,4 @@
-pytest
-codecov
-pytest-cov
-bashlex
+pytest==3.5.0
+codecov==2.0.15
+pytest-cov==2.5.1
+bashlex==0.12

protowhat/tests/test_check_simple.py → tests/test_check_simple.py

@@ -16,8 +16,7 @@ def prepare_state(student_code):
         solution_code = "NA", pre_exercise_code = "NA", 
         solution_ast = "NA", student_ast = "NA",
         student_result = [], solution_result = [],
-        student_conn = None, solution_conn = None,
-        ast_dispatcher = "NA")
+        student_conn = None, solution_conn = None)
 
 def test_mc_alone_pass():
     state = prepare_state("selected_option = 1")