Release 3.1.0

CHANGELOG.md

@@ -1,5 +1,25 @@
 # Changelog
 
+## 3.1.0
+
+- Add step by step introduction/tutorial to question pages.
+- Add third party licence files.
+- Update README.
+- Dependency updates:
+    - Update coverage from 5.1 to 5.2.1.
+    - Update django-extensions from 2.2.9 to 3.0.8.
+    - Update django-storages[google] from 1.9.1 to 1.10.
+    - Update google-auth from 1.12.0 to 1.21.1.
+    - Update google-cloud-logging from 1.15.0 to 1.15.1.
+    - Update mypy from 0.770 to 0.782.
+    - Update Pillow from 7.0.0 to 7.2.0.
+    - Update psycopg2-binary from 3.0.4 to 3.2.1.
+    - Update pydocstyle from 5.0.2 to 5.1.1.
+    - Update pytest from 5.3.5 to 6.0.1.
+    - Update pytest-django from 3.8.0 to 3.9.0.
+    - Update pytest-sugar from 0.9.2 to 0.9.4.
+    - Update Sphinx from 2.8.4 to 2.8.6.
+
 ## 3.0.0
 
 Add style checker for beginners.

README.md

@@ -1,7 +1,42 @@
 # CodeWOF
 
-A website for maintaining your basic programming skills.
+[![Build Status](https://travis-ci.org/uccser/codewof.svg?branch=master)](https://travis-ci.org/uccser/codewof)
 
-## License
+CodeWOF is a website for maintaining your basic programming skills, developed at the University of Canterbury in New Zealand.
+The latest release of CodeWOF can be viewed at [https://www.codewof.co.nz/](https://www.codewof.co.nz/).
 
-This repository is licensed under the [MIT license](https://opensource.org/licenses/MIT) (`LICENSE` file).
+## Features
+
+There are two major features of the CodeWOF project:
+
+- Programming 'fitness' helper:
+  With a free account you can maintain your basic programming skills with short daily programming exercises.
+  Earn points and achievements while maintaining your coding Warrant of Fitness.
+- Style checkers:
+  We've rewritten professional code style standards to make them easier to understand for beginners.
+  Our [style checkers](https://www.codewof.co.nz/style/) review your code with professional standards but provide simplified descriptions and examples to easily help you improve your coding style (no account needed).
+
+Currently both features are available for Python 3; we would like to introduce more languages in future updates.
+
+## Documentation
+
+This is it! All of it.
+We intend to create proper documentation in a full `docs` directory in the near future.
+Don't be afraid to ask for help!
+
+## Contributing
+
+We would love your help to make CodeWOF as useful as it can be!
+A contribution guide will be made available in the future.
+
+## Licence
+
+Third-party libraries used in this project have their licences listed within the `LICENCE-THIRD-PARTY` file, with a full copy of the licence available within the `third-party-licences` directory.
+If a source file of a third-party library or system is stored within this repository, then a copyright notice should be present at the top of the file.
+
+This rest of the project is licensed under the [MIT licence](https://opensource.org/licenses/MIT) (`LICENCE` file).
+This licence applies to the content and all other underlying code used to manage and display the content.
+
+## Contact
+
+You can contact us at [csse-education-research@canterbury.ac.nz](mailto:csse-education-research@canterbury.ac.nz).

codewof/config/__init__.py

@@ -1,6 +1,6 @@
 """Configuration for Django system."""
 
-__version__ = "3.0.0"
+__version__ = "3.1.0"
 __version_info__ = tuple(
     [
         int(num) if num.isdigit() else num

codewof/package.json

@@ -9,6 +9,7 @@
     "clipboard": "2.0.6",
     "details-element-polyfill": "2.3.1",
     "fuse.js": "3.4.4",
+    "intro.js": "2.9.3",
     "jquery": "3.4.1",
     "popper.js": "1.15.0",
     "skulpt": "0.11.1",
@@ -19,7 +20,6 @@
     "@babel/core": "7.4.4",
     "@babel/preset-env": "7.4.4",
     "browserify": "16.2.3",
-    "child_process": "1.0.2",
     "del": "4.1.1",
     "gulp": "4.0.2",
     "gulplog": "1.0.0",

codewof/programming/content/en/triangle-pattern/question.md

@@ -11,4 +11,4 @@ For example if we call `triangle(5)` we would expect the output to be:
 *****
 ```
 
-If `x` is less than 1 (inclusive), your function should **print** `That isn't a triangle!`
+If `x` is 1 or less, your function should **print** `That isn't a triangle!`

codewof/static/css/third-party/introjs-modern.css

@@ -0,0 +1,62 @@
+/**
+ * Intro.js v2.9.3
+ * https://github.com/usablica/intro.js
+ *
+ * Copyright (C) 2017 Afshin Mehrabani (@afshinmeh)
+ */
+
+.introjs-tooltip {
+  background-color: rgba(000, 0, 0, 0.5);
+  color: #fff;
+}
+
+.introjs-button,
+.introjs-button:hover, .introjs-button:focus, .introjs-button:active,
+.introjs-disabled, .introjs-disabled:focus, .introjs-disabled:hover {
+  outline: none;
+  background-image: none;
+  background-color: transparent;
+  color: #fff;
+  border: 1px solid transparent;
+  border-radius: 50px;
+  box-shadow: none;
+  border-shadow: none;
+  text-shadow: none;
+}
+
+.introjs-button:hover, .introjs-button:focus, .introjs-button:active {
+  border: 1px solid #fff
+}
+.introjs-disabled, .introjs-disabled:focus, .introjs-disabled:hover {
+  color: #ccc;
+  border: 1px solid transparent;
+}
+
+.introjs-arrow {
+  border: 10px solid #fff;
+}
+.introjs-arrow.top, .introjs-arrow.top-middle, .introjs-arrow.top-right {
+  border-color: transparent transparent rgba(000, 0, 0, 0.5);
+  top: -20px;
+  left: 20px;
+}
+.introjs-arrow.bottom, .introjs-arrow.bottom-middle, .introjs-arrow.bottom-right {
+  border-color: rgba(000, 0, 0, 0.5) transparent transparent;
+  bottom: -20px;
+  left: 20px;
+}
+.introjs-arrow.left, .introjs-arrow.right {
+    top: 20px;
+}
+.introjs-arrow.left-bottom, .introjs-arrow.right-bottom {
+    bottom: 20px;
+}
+
+.introjs-arrow.left, .introjs-arrow.left-bottom {
+  left: -20px;
+  border-color: transparent rgba(000, 0, 0, 0.5) transparent transparent;
+}
+.introjs-arrow.right, .introjs-arrow.right-bottom {
+  right: -20px;
+  border-color: transparent transparent transparent rgba(000, 0, 0, 0.5);
+}