Merge branch 'release-0.4.0'

.codeclimate.yml

@@ -27,4 +27,4 @@ ratings:
    paths:
    - "**.py"
 exclude_paths:
-- "kordac/tests/*"
+- "verto/tests/*"

.flake8

@@ -0,0 +1,22 @@
+[flake8]
+exclude =
+    # No need to traverse our git or venv directories
+    .git,
+    venv,
+
+    # Don't process our PyPi script
+    ./setup.py,
+
+    # There's no value in checking cache directories
+    __pycache__,
+
+    # This contains our documentation
+    docs,
+
+    # This contains tests that we don't want to check
+    verto/tests,
+
+show-source = True
+statistics = True
+count = True
+max-line-length=119

.github/ISSUE_TEMPLATE.md

@@ -0,0 +1,21 @@
+## Description
+
+Clearly and concisely describe the issue or suggestion here:
+
+
+
+
+
+
+
+### Checklist
+
+*Change the space in the box to an `x` for those that apply. You can also fill these out after creating the issue.*
+
+- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/verto/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)
+
+If this is a code related issue, please include the following in your description:
+
+- [ ] Steps to reproduce the behavior
+- [ ] The platform(s) you are encountering the issue on
+- [ ] The behavior you expect to see, and the actual behavior

.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,22 @@
+## Proposed changes
+
+Describe the big picture of your changes here to communicate to the maintainers why we should accept this pull request:
+
+
+
+
+
+
+
+### Checklist
+
+*Change the space in the box to an `x` for those that apply. You can also fill these out after creating the pull request. If you're unsure about any of them, don't hesitate to ask. We're here to help! This is simply a reminder of what we are going to look for before merging your change.*
+
+- [ ] I have read the [contribution guidelines](.github/CONTRIBUTING.md)
+- [ ] I have linked any relevant [existing issues/suggestions](https://github.com/uccser/verto/issues) in the description above (include `#???` in your description to reference an issue, where `???` is the issue number)
+- [ ] I have run the test suite and all tests passed
+- [ ] I have added necessary documentation (if appropriate)
+
+### Further comments
+
+If this is a relatively large or complex change, kick off the discussion by explaining why you chose the solution you did and what alternatives you considered, etc. Feel free to add any images that might be helpful to understand the initial problem/solution.

.travis.yml

@@ -8,10 +8,14 @@ python:
   - "3.6-dev" # 3.6 development branch
 
 # Install dependencies
-install: pip install -r requirements.txt
+install:
+  - pip install flake8
+  - pip install -r requirements.txt
 
 # Runs test suite
-script: python -m kordac.tests.start_tests --travis
+script:
+  - flake8
+  - python -m verto.tests.start_tests --travis
 
 # Stop email notifications but post to organisation Slack channel
 notifications:

CODE_OF_CONDUCT.md

@@ -0,0 +1,74 @@
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+In the interest of fostering an open and welcoming environment, we as
+contributors and maintainers pledge to making participation in our project and
+our community a harassment-free experience for everyone, regardless of age, body
+size, disability, ethnicity, gender identity and expression, level of experience,
+nationality, personal appearance, race, religion, or sexual identity and
+orientation.
+
+## Our Standards
+
+Examples of behavior that contributes to creating a positive environment
+include:
+
+- Using welcoming and inclusive language
+- Being respectful of differing viewpoints and experiences
+- Gracefully accepting constructive criticism
+- Focusing on what is best for the community
+- Showing empathy towards other community members
+
+Examples of unacceptable behavior by participants include:
+
+- The use of sexualized language or imagery and unwelcome sexual attention or
+  advances
+- Trolling, insulting/derogatory comments, and personal or political attacks
+- Public or private harassment
+- Publishing others' private information, such as a physical or electronic
+  address, without explicit permission
+- Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Our Responsibilities
+
+Project maintainers are responsible for clarifying the standards of acceptable
+behavior and are expected to take appropriate and fair corrective action in
+response to any instances of unacceptable behavior.
+
+Project maintainers have the right and responsibility to remove, edit, or
+reject comments, commits, code, wiki edits, issues, and other contributions
+that are not aligned to this Code of Conduct, or to ban temporarily or
+permanently any contributor for other behaviors that they deem inappropriate,
+threatening, offensive, or harmful.
+
+## Scope
+
+This Code of Conduct applies both within project spaces and in public spaces
+when an individual is representing the project or its community. Examples of
+representing a project or community include using an official project e-mail
+address, posting via an official social media account, or acting as an appointed
+representative at an online or offline event. Representation of a project may be
+further defined and clarified by project maintainers.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported by contacting the project team at [csse-education-research@canterbury.ac.nz](mailto:csse-education-research@canterbury.ac.nz). All
+complaints will be reviewed and investigated and will result in a response that
+is deemed necessary and appropriate to the circumstances. The project team is
+obligated to maintain confidentiality with regard to the reporter of an incident.
+Further details of specific enforcement policies may be posted separately.
+
+Project maintainers who do not follow or enforce the Code of Conduct in good
+faith may face temporary or permanent repercussions as determined by other
+members of the project's leadership.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
+available at [http://contributor-covenant.org/version/1/4][version]
+
+[homepage]: http://contributor-covenant.org
+[version]: http://contributor-covenant.org/version/1/4/

CONTRIBUTING.md

@@ -0,0 +1,59 @@
+# Contributing Guide
+
+Welcome to the Verto developer community! We have spent many months developing this project, and we would love for you to get involved!
+
+We've written a technical guide about how Verto works and how to contribute [here](verto.readthedocs.io/en/develop/contributing.html). These docs should give you a good overview of how Verto is pieced together.
+
+Below are a few more general notes to remember while you are working on Verto.
+
+### Code of Conduct
+
+This project adheres to the Contributor Covenant [code of conduct](CODE_OF_CONDUCT.md).
+By participating, you are expected to uphold this code.
+Please report unacceptable behavior to [csse-education-research@canterbury.ac.nz](mailto:csse-education-research@canterbury.ac.nz)
+
+### Reporting issues
+
+This section guides you through submitting an issue for Verto.
+Following these guidelines helps maintainers and the community understand your findings.
+
+Before submitting an issue, please take a look at the [issues](https://github.com/uccser/verto/issues) on the repository to check it hasn't already been reported.
+
+### Your first code contribution
+
+Unsure where to begin contributing to Verto? Take a look at the [issues](https://github.com/uccser/verto/issues) on the repository.
+
+### Pull requests
+
+- Include a detailed explaination of the proposed change
+- Read and applied the [style guides listed below](#style-guides).
+- Your pull request should be on a new branch from our `develop` branch (unless it's something tiny like a typo). The naming conventions of branches should be descriptive of the new addition/modification. Ideally they would specify their namespace as well, for example:
+  - `processor/image`
+  - `issue/234`
+- Linked any relevant [existing issues](https://github.com/uccser/verto/issues).
+- Run the test suite and all tests passed
+- Added necessary documentation (if appropriate).
+
+## Style guides
+
+### Git
+
+- Commits should be as descriptive as possible. Other developers (and even future you) will thank you for your forethought and verbosity for well documented commits. [Ideally follow this commit structure](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html), otherwise in short:
+  - Limit the first line to 72 characters or less
+  - Reference issues and pull requests liberally
+- Use [Vincent Driessen's Git Branching Model](http://nvie.com/posts/a-successful-git-branching-model/) for managing development. Please read this document to understand our branching methods.
+
+### Programming
+
+> Every line of code should appear to be written by a single person, no matter the number of contributors.
+
+These are our abridged guidelines for working on code within this repository:
+- Code should be easily readable (avoid abbreviations etc)
+- Files should be set to `utf-8`, use `lf` line endings, and have a final newline at the end of a file.
+- Functions should have comments/docstrings explaining their purpose.
+- Indents should be spaces (not tab characters)
+- Indent sizes:
+  - HTML: 2 spaces
+  - Python: 4 spaces
+
+We aim to follow the [PEP8 style guide](https://www.python.org/dev/pep-0008/) and use [Flake8](flake8.pycqa.org/en/latest/) to enforce this.

MANIFEST.in

@@ -1,3 +1,3 @@
 include *.txt
 include *.md
-recursive-include kordac *.html *.py *.png *.conf *.md *.json
+recursive-include verto *.html *.py *.png *.conf *.md *.json

README.rst

@@ -1,23 +1,23 @@
-.. figure:: kordac/images/kordac-logo.png
-   :alt: Kordac Logo
+.. figure:: verto/images/verto-logo.png
+   :alt: Verto Logo
 
 |Build Status| |Code Climate Status|
 
-Kordac is an extension of the Python Markdown package, which allows
+Verto is an extension of the Python Markdown package, which allows
 authors to include complex HTML elements with simple text tags in their
 Markdown files.
 
 Documentation
 -------------
 
-Installation and usage documentation for Kordac can be found on
+Installation and usage documentation for Verto can be found on
 `ReadTheDocs`_, and can also be built from the documentation source
 within the ``docs/`` directory of the development distribution.
 
 License
 -------
 
-Kordac is licensed under the MIT License. Read the `license file`_ for
+Verto is licensed under the MIT License. Read the `license file`_ for
 more details.
 
 Bugs and feature requests
@@ -36,19 +36,19 @@ The changelog is available within the `documentation`_.
 
 **How do I install the development version as local package?**
 
-1. ``$ git clone https://github.com/uccser/kordac.git``
-2. ``$ cd kordac``
+1. ``$ git clone https://github.com/uccser/verto.git``
+2. ``$ cd verto``
 3. ``$ pip3 install .``
 
-.. _ReadTheDocs: http://kordac.readthedocs.io/en/latest/
-.. _documentation: http://kordac.readthedocs.io/en/latest/changelog.html
+.. _ReadTheDocs: http://verto.readthedocs.io/en/latest/
+.. _documentation: http://verto.readthedocs.io/en/latest/changelog.html
 .. _license file: LICENSE.md
-.. _existing and closed issues: https://github.com/uccser/kordac/issues
-.. _open a new issue: https://github.com/uccser/kordac/issues/new
+.. _existing and closed issues: https://github.com/uccser/verto/issues
+.. _open a new issue: https://github.com/uccser/verto/issues/new
 
-.. |Build Status| image:: https://travis-ci.org/uccser/kordac.svg?branch=master
-   :target: https://travis-ci.org/uccser/kordac
+.. |Build Status| image:: https://travis-ci.org/uccser/verto.svg?branch=master
+   :target: https://travis-ci.org/uccser/verto
 
-.. |Code Climate Status| image:: https://codeclimate.com/github/uccser/kordac/badges/gpa.svg
-  :target: https://codeclimate.com/github/uccser/kordac
+.. |Code Climate Status| image:: https://codeclimate.com/github/uccser/verto/badges/gpa.svg
+  :target: https://codeclimate.com/github/uccser/verto
   :alt: Code Climate

docs/Makefile

@@ -4,7 +4,7 @@
 # You can set these variables from the command line.
 SPHINXOPTS    =
 SPHINXBUILD   = sphinx-build
-SPHINXPROJ    = Kordac
+SPHINXPROJ    = Verto
 SOURCEDIR     = source
 BUILDDIR      = build
 

docs/make.bat

@@ -1,15 +1,26 @@
 @ECHO OFF
-
+setlocal
 pushd %~dp0
 
 REM Command file for Sphinx documentation
 
+
 if "%SPHINXBUILD%" == "" (
 	set SPHINXBUILD=sphinx-build
 )
+if "%SPHINXOPTS%" == "" (
+	if not "%1" == "SPHINXOPTS" goto :skip
+)
+shift /1
+set SPHINXOPTS=%1
+set SPHINXOPTS=%SPHINXOPTS:~1,-1%
+shift /1
+:skip
+
+
 set SOURCEDIR=source
 set BUILDDIR=build
-set SPHINXPROJ=Kordac
+set SPHINXPROJ=Verto
 
 if "%1" == "" goto help
 
@@ -34,3 +45,4 @@ goto end
 
 :end
 popd
+endlocal