examples & readme update

Author: ShMcK

CHANGELOG.md

@@ -2,4 +2,5 @@
 All notable changes to this project will be documented in this file.
 This project adheres to [Semantic Versioning](http://semver.org/).
 
-## [0.1.0] - under development
+## [0.1.0] - 2016-04-01
+- initial working version

README.md

@@ -36,3 +36,30 @@ Test method providing the feedback message and starting with `test_`
         def test_a_is_not_one(self):
           assert a == 1
           # fails with message "a is not one"
+
+
+##### Loading Workspace Files
+
+Workspace files (created by the user) can be loaded inside of comments
+
+    # load('file.py')
+
+These files will be loaded from the users working directory.
+
+##### Loading Data Files
+
+Data files can be by setting a second parameter to `true`.
+
+    # load('path/to/data.py', true)
+
+These files will load from the specified tutorial directory in *package.json*.
+
+*package.json*
+
+    config {
+      tutorialDir: 'tutorial'
+    }
+
+##### Complete Example
+
+See the [examples](//github.com/coderoad/pytest-coderoad) directory.

examples/basic/README.md

@@ -0,0 +1,28 @@
+# PyTest Demo
+
+A demo for testing Python's PyTest in CodeRoad.
+
+
+## CodeRoad
+
+CodeRoad is an open-sourced interactive tutorial platform for the Atom Editor. Learn more at [CodeRoad.io](http://coderoad.io).
+
+
+## Setup
+
+* install the tutorial package
+
+    `npm install --save coderoad-pytest-demo`
+
+* install and run the [atom-coderoad](https://github.com/coderoad/atom-coderoad) plugin
+
+
+## Outline
+
+### Basic
+
+Some basic tests to try out PyTest.
+
+##### Math
+
+Some basic math.

examples/basic/coderoad.json

@@ -0,0 +1,48 @@
+{
+  "project": {
+    "title": "PyTest Demo",
+    "description": "A demo for testing Python's PyTest in CodeRoad."
+  },
+  "chapters": [
+    {
+      "title": "Basic",
+      "description": "Some basic tests to try out PyTest.",
+      "pages": [
+        {
+          "title": "Math",
+          "description": "Some basic math.\n\nAddition:\n`1 + 1 == 2`\n\nSubtraction:\n`2 - 1 == 1`",
+          "tasks": [
+            {
+              "description": "This test should pass automatically.",
+              "tests": [
+                "1/01/01-add"
+              ],
+              "actions": [
+                "open('math.py')",
+                "set('# add')"
+              ]
+            },
+            {
+              "description": "This test should also pass automatically",
+              "tests": [
+                "1/01/02-subtract"
+              ],
+              "actions": [
+                "insert('# subtract')"
+              ]
+            },
+            {
+              "description": "Set a variable `a` to 1",
+              "tests": [
+                "1/01/03-value"
+              ],
+              "actions": [
+                "insert('# value')"
+              ]
+            }
+          ]
+        }
+      ]
+    }
+  ]
+}

examples/basic/package.json

@@ -0,0 +1,22 @@
+{
+  "name": "coderoad-pytest-demo",
+  "version": "0.1.0",
+  "description": "Demo for pytest runner",
+  "main": "coderoad.json",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "author": "Shawn McKay <shawn.j.mckay@gmail.com>",
+  "license": "ISC",
+  "engines": {
+    "node": ">= 0.10.3"
+  },
+  "dependencies": {
+    "pytest-coderoad": "^0.1.0"
+  },
+  "config": {
+    "testDir": "tutorial",
+    "testSuffix": ".py",
+    "testRunner": "pytest-coderoad"
+  }
+}

examples/basic/tutorial/1/01/01-add.py

@@ -0,0 +1,5 @@
+# load('math.py')
+
+class Test01Class:
+    def test_add_one(self):
+        assert 1 + 1 == 2

examples/basic/tutorial/1/01/02-subtract.py

@@ -0,0 +1,3 @@
+class Test02Class:
+    def test_subtract_one(self):
+        assert 2 - 1 == 1

examples/basic/tutorial/1/01/03-value.py

@@ -0,0 +1,3 @@
+class Test03Class:
+    def test_a_should_be_1(self):
+        assert a == 1

examples/basic/tutorial/1/01/math.md

@@ -0,0 +1,21 @@
+### Math
+Some basic math.
+
+Addition:
+`1 + 1 == 2`
+
+Subtraction:
+`2 - 1 == 1`
+
++ This test should pass automatically.
+@test('1/01/01-add')
+@action(open('math.py'))
+@action(set('# add'))
+
++ This test should also pass automatically
+@test('1/01/02-subtract')
+@action(insert('# subtract'))
+
++ Set a variable `a` to 1
+@test('1/01/03-value')
+@action(insert('# value'))

examples/basic/tutorial/tutorial.md

@@ -0,0 +1,9 @@
+# PyTest Demo
+
+A demo for testing Python's PyTest in CodeRoad.
+
+## Basic
+
+Some basic tests to try out PyTest.
+
+@import('./tutorial/1/01/math')