Browse Source

Merge branch 'release/20180716'

master
Sam Black 2 years ago
parent
commit
e98f0ae33a
100 changed files with 80738 additions and 1623 deletions
  1. +13
    -0
      .gitignore
  2. +73
    -23
      CHANGELOG.rst
  3. +0
    -22
      LICENCES/AdminLTE
  4. +20
    -0
      LICENCES/c3js
  5. +24
    -0
      LICENCES/classList
  6. +26
    -0
      LICENCES/d3js
  7. +18
    -0
      LICENCES/datatables
  8. +12
    -0
      LICENCES/dropzone
  9. +22
    -0
      LICENCES/fastclick
  10. +201
    -0
      LICENCES/foundation-datepicker
  11. +36
    -0
      LICENCES/jquery
  12. +48
    -0
      LICENCES/jquery-ui
  13. +8
    -0
      LICENCES/jquery.typewatch
  14. +19
    -0
      LICENCES/reveal.js
  15. +0
    -0
      LICENCES/tinymce
  16. +7
    -0
      LICENCES/uikit3
  17. +21
    -0
      LICENCES/what-input
  18. +38
    -38
      README.rst
  19. +0
    -16
      deployment/gunicorn.py
  20. +0
    -56
      deployment/nginx.conf
  21. +0
    -10
      deployment/rq_settings.conf
  22. +13
    -0
      deployment/sponson/gunicorn.py
  23. +78
    -0
      deployment/sponson/nginx.conf
  24. +10
    -0
      deployment/sponson/rq_settings.conf
  25. +15
    -0
      deployment/sponson/systemd/vowel-rq_all@.service
  26. +15
    -0
      deployment/sponson/systemd/vowel-rq_high@.service
  27. +15
    -0
      deployment/sponson/systemd/vowel-rq_scheduler.service
  28. +20
    -0
      deployment/sponson/systemd/vowel-runtime.service
  29. +15
    -0
      deployment/sponson/systemd/vowel-soffice.service
  30. +0
    -18
      deployment/systemd/vowel-rq_all@.service
  31. +0
    -18
      deployment/systemd/vowel-rq_high@.service
  32. +0
    -18
      deployment/systemd/vowel-rq_scheduler.service
  33. +0
    -8
      deployment/systemd/vowel.slice
  34. +0
    -21
      deployment/systemd/vowel_runtime.service
  35. +2
    -0
      deployment/tmpfiles.d/vowel-gunicorn.conf
  36. +177
    -0
      docs/developer/Makefile
  37. +345
    -0
      docs/developer/conf.py
  38. +28
    -0
      docs/developer/index.rst
  39. +72
    -0
      docs/developer/models.rst
  40. +7
    -0
      docs/developer/utils/forms.rst
  41. +12
    -0
      docs/developer/utils/index.rst
  42. +68
    -0
      docs/developer/utils/utils.rst
  43. +72
    -0
      docs/developer/views/forms.rst
  44. +14
    -0
      docs/developer/views/index.rst
  45. +7
    -0
      docs/developer/views/rest.rst
  46. +76
    -0
      docs/developer/views/views.rst
  47. +0
    -2
      migrations/env.py
  48. +33
    -0
      migrations/versions/02c2b594dde0_.py
  49. +40
    -0
      migrations/versions/056e315c9f5e_.py
  50. +28
    -0
      migrations/versions/132dc68235a_.py
  51. +60
    -0
      migrations/versions/29c9fbe9c7f_.py
  52. +27
    -0
      migrations/versions/2d8601fed0c_.py
  53. +144
    -0
      migrations/versions/419e2215ef91_.py
  54. +37
    -0
      migrations/versions/5948e1b95495_.py
  55. +51
    -0
      migrations/versions/647c030e81cf_.py
  56. +47
    -0
      migrations/versions/70573a6f499d_.py
  57. +25
    -0
      migrations/versions/7742542698af_.py
  58. +52
    -0
      migrations/versions/7948fd659ddc_.py
  59. +34
    -0
      migrations/versions/7b0c952a296c_.py
  60. +81
    -0
      migrations/versions/a064eeec1425_.py
  61. +26
    -0
      migrations/versions/be87adb27f7b_.py
  62. +40
    -0
      migrations/versions/c576636d1bfe_.py
  63. +34
    -0
      migrations/versions/c5dd2bd49172_.py
  64. +59
    -0
      migrations/versions/df0409ac260c_.py
  65. +1
    -0
      requirements.testing.txt
  66. +16
    -10
      requirements.txt
  67. +77
    -65
      run.py
  68. +0
    -19
      testing/__init__.py
  69. +0
    -19
      testing/unittests/__init__.py
  70. +0
    -248
      testing/unittests/base.py
  71. +0
    -19
      testing/unittests/web/__init__.py
  72. +0
    -64
      testing/unittests/web/test_annotations.py
  73. +0
    -99
      testing/unittests/web/test_assessment.py
  74. +0
    -223
      testing/unittests/web/test_course.py
  75. +0
    -46
      testing/unittests/web/test_dashboard.py
  76. +0
    -163
      testing/unittests/web/test_lesson.py
  77. +0
    -51
      testing/unittests/web/test_organisation.py
  78. +0
    -128
      testing/unittests/web/test_presentation.py
  79. +0
    -34
      testing/unittests/web/test_resources.py
  80. +0
    -183
      testing/unittests/web/test_user.py
  81. +83
    -0
      vowel.yaml
  82. +15
    -2
      vowel/__init__.py
  83. +9236
    -0
      vowel/assets/js/charts/c3-0.4.18.js
  84. +9554
    -0
      vowel/assets/js/charts/d3-3.5.17.js
  85. +1359
    -0
      vowel/assets/js/datatables/dataTables.colReorder.js
  86. +677
    -0
      vowel/assets/js/datatables/dataTables.fixedHeader.js
  87. +1369
    -0
      vowel/assets/js/datatables/dataTables.responsive.js
  88. +1410
    -0
      vowel/assets/js/datatables/dataTables.scroller.js
  89. +1156
    -0
      vowel/assets/js/datatables/dataTables.select.js
  90. +176
    -0
      vowel/assets/js/datatables/dataTables.uikit.js
  91. +15243
    -0
      vowel/assets/js/datatables/jquery.dataTables.js
  92. +1410
    -0
      vowel/assets/js/datetime/foundation-datepicker.js
  93. +14933
    -0
      vowel/assets/js/datetime/fullcalendar.js
  94. +78
    -0
      vowel/assets/js/datetime/moment-round.js
  95. +4535
    -0
      vowel/assets/js/datetime/moment.js
  96. +44
    -0
      vowel/assets/js/datetime/timedurationpicker.js
  97. +3504
    -0
      vowel/assets/js/dropzone/dropzone.js
  98. +3040
    -0
      vowel/assets/js/fontawesome/fontawesome-all.js
  99. +10253
    -0
      vowel/assets/js/jquery/jquery-3.2.1.js
  100. +104
    -0
      vowel/assets/js/jquery/jquery.typewatch-3.0.0.js

+ 13
- 0
.gitignore View File

@@ -53,6 +53,7 @@ coverage.xml
*.log

# Sphinx documentation
docs/*/_build/
docs/_build/

# PyBuilder
@@ -87,6 +88,12 @@ com_crashlytics_export_strings.xml
crashlytics.properties
crashlytics-build.properties

# SonarQube
.scannerwork/
sonar-project.properties

# Vagrant
.vagrant/

### Linux template
*~
@@ -102,6 +109,12 @@ crashlytics-build.properties
.sass-cache
*.css.map

# Webassets
.webassets-cache/
webassets-external/
vowel/static/css/
vowel/static/js/

### Vowel instances
instance/
testing/data/.~lock*

+ 73
- 23
CHANGELOG.rst View File

@@ -2,36 +2,86 @@
Vowel ChangeLog
===============

0.1.2 2015-11-03
================
All notable changes to this project will be documented in this file.
This project adheres to `PEP 440 <https://www.python.org/dev/peps/pep-0440/>`_.

Scheduled functions (such as deleting files) caused an infinite feedback loop,
where every run of the deletion function would create
another scheduled run of the function,
which would create another scheduled run of the function and so on.
Other minor fixes.
Unreleased_
===========

#. Remove circular scheduling starts when using `web.create_app`
#. Resource deletion needs to be in an app context.
#. Don't enrol users already enrolled to a course
#. Split email list on commas as well as newlines.
#. Ensure our services restart on failure.
#. Fix incorrect attributes for course instance in text emails sent to users.
#. Relabel "essay" to "assignment".
#. iCheck is not used for checkboxes, so remove it's specific event names.
.. _Unreleased: https://code.lapwing.org/vowel/vowel/branch/develop

Added
-----

0.1.1 2015-11-01
================
- Sponson support
- Redirect to dashboard on 404 error
- Import PDFs as presentations
- Import PPT/ODP as presentations
- Timed and open book assessments
- Split courses into reusable modules
- Optional commercial mode
- Theming for organisations

Fix minor bugs.
Changed
-------

#. Fix listing lesson primary resources in the dashboard overview.
#. Limit assessment criteria for new assessments to those of the course.
#. Replace "AioHTTPTransport" with greenlet Transport for Raven.
- Show organisations even if they are disabled
- Harden session cookie security
- Use filesystem to store uploaded files
- Use UIKit3 for the interface
- Flask 0.11 as the minimum version requirement
- Updated libraries
- Move to new URL scheme

Removed
-------

0.1 2015-10-30
==============
- MongoDB requirement


0.1.2_ 2015-11-03
=================

.. _0.1.2: https://code.lapwing.org/vowel/vowel/c/a408943dec5e947ce9b32856991751f83132fb2a..b52b027642a4bfcc868cf34c16ca3fe42a1ba6c9

Added
-----

- Split email list on commas as well as newlines.
- Ensure our services restart on failure.

Fixed
-----

- Remove circular scheduling starts when using `web.create_app`
- Resource deletion needs to be in an app context.
- Don't enrol users already enrolled to a course
- iCheck is not used for checkboxes, so remove it's specific event names.


0.1.1_ 2015-11-01
=================

.. _0.1.1: https://code.lapwing.org/vowel/vowel/c/622e3f9a0411731eee05e275da9a008507a8bd88..a408943dec5e947ce9b32856991751f83132fb2a

Changed
-------

- Replace "AioHTTPTransport" with greenlet Transport for Raven.

Fixed
-----

- Fix listing lesson primary resources in the dashboard overview.
- Limit assessment criteria for new assessments to those of the course.


0.1_ 2015-10-30
===============

.. _0.1: https://code.lapwing.org/vowel/vowel/tree/9919db3d291dbd859a340a7a53d7d76704ff73b4

Added
-----

Initial version with most functionality.

+ 0
- 22
LICENCES/AdminLTE View File

@@ -1,22 +0,0 @@
AdminLTE HTML/CSS/JS Theme

The MIT License (MIT)

Copyright (c) 2014-2015 almasaeed2010

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 20
- 0
LICENCES/c3js View File

@@ -0,0 +1,20 @@
The MIT License (MIT)

Copyright (c) 2013 Masayuki Tanaka

Permission is hereby granted, free of charge, to any person obtaining a copy of
this software and associated documentation files (the "Software"), to deal in
the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS
FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR
COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER
IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN
CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 24
- 0
LICENCES/classList View File

@@ -0,0 +1,24 @@
This is free and unencumbered software released into the public domain.

Anyone is free to copy, modify, publish, use, compile, sell, or
distribute this software, either in source code form or as a compiled
binary, for any purpose, commercial or non-commercial, and by any
means.

In jurisdictions that recognize copyright laws, the author or authors
of this software dedicate any and all copyright interest in the
software to the public domain. We make this dedication for the benefit
of the public at large and to the detriment of our heirs and
successors. We intend this dedication to be an overt act of
relinquishment in perpetuity of all present and future rights to this
software under copyright law.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS BE LIABLE FOR ANY CLAIM, DAMAGES OR
OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

For more information, please refer to <http://unlicense.org/>

+ 26
- 0
LICENCES/d3js View File

@@ -0,0 +1,26 @@
Copyright (c) 2010-2016, Michael Bostock
All rights reserved.

Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:

* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.

* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.

* The name Michael Bostock may not be used to endorse or promote products
derived from this software without specific prior written permission.

THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL MICHAEL BOSTOCK BE LIABLE FOR ANY DIRECT,
INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING,
BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY
OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING
NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE,
EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

+ 18
- 0
LICENCES/datatables View File

@@ -0,0 +1,18 @@
Copyright (C) 2008-2017, SpryMedia Ltd.

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom
the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE,
ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 12
- 0
LICENCES/dropzone View File

@@ -0,0 +1,12 @@
License

(The MIT License)

Copyright (c) 2012 Matias Meno <m@tias.me>
Logo & Website Design (c) 2015 "1910" www.weare1910.com

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 22
- 0
LICENCES/fastclick View File

@@ -0,0 +1,22 @@
Copyright (c) 2014 The Financial Times Ltd.

Permission is hereby granted, free of charge, to any person
obtaining a copy of this software and associated documentation
files (the "Software"), to deal in the Software without
restriction, including without limitation the rights to use,
copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following
conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
OTHER DEALINGS IN THE SOFTWARE.

+ 201
- 0
LICENCES/foundation-datepicker View File

@@ -0,0 +1,201 @@
Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/

TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION

1. Definitions.

"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.

"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.

"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.

"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.

"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.

"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.

"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).

"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.

"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."

"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.

2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.

3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.

4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:

(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and

(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and

(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and

(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.

You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.

5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.

6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.

7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.

8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.

9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.

END OF TERMS AND CONDITIONS

APPENDIX: How to apply the Apache License to your work.

To apply the Apache License to your work, attach the following
boilerplate notice, with the fields enclosed by brackets "{}"
replaced with your own identifying information. (Don't include
the brackets!) The text should be enclosed in the appropriate
comment syntax for the file format. We also recommend that a
file or class name and description of purpose be included on the
same "printed page" as the copyright notice for easier
identification within third-party archives.

Copyright 2015 Peter Beno

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

+ 36
- 0
LICENCES/jquery View File

@@ -0,0 +1,36 @@
Copyright jQuery Foundation and other contributors, https://jquery.org/

This software consists of voluntary contributions made by many
individuals. For exact contribution history, see the revision history
available at https://github.com/jquery/jquery

The following license applies to all parts of this software except as
documented below:

====

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

====

All files located in the node_modules and external directories are
externally maintained libraries used by this software which have their
own licenses; we recommend you read them, as their terms may differ from
the terms above.

+ 48
- 0
LICENCES/jquery-ui View File

@@ -0,0 +1,48 @@
The jquery-ui code bundled with Vowel includes
only the core and sortable modules.

======================

Copyright jQuery Foundation and other contributors, https://jquery.org/

This software consists of voluntary contributions made by many
individuals. For exact contribution history, see the revision history
available at https://github.com/jquery/jquery-ui

The following license applies to all parts of this software except as
documented below:

====

Permission is hereby granted, free of charge, to any person obtaining
a copy of this software and associated documentation files (the
"Software"), to deal in the Software without restriction, including
without limitation the rights to use, copy, modify, merge, publish,
distribute, sublicense, and/or sell copies of the Software, and to
permit persons to whom the Software is furnished to do so, subject to
the following conditions:

The above copyright notice and this permission notice shall be
included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

====

Copyright and related rights for sample code are waived via CC0. Sample
code is defined as all source code contained within the demos directory.

CC0: http://creativecommons.org/publicdomain/zero/1.0/

====

All files located in the node_modules and external directories are
externally maintained libraries used by this software which have their
own licenses; we recommend you read them, as their terms may differ from
the terms above.

+ 8
- 0
LICENCES/jquery.typewatch View File

@@ -0,0 +1,8 @@
Copyright (c) 2017 Denny Ferrassoli <denny.ferrassoli@gmail.com>
https://github.com/dennyferra/TypeWatch/

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 19
- 0
LICENCES/reveal.js View File

@@ -0,0 +1,19 @@
Copyright (C) 2016 Hakim El Hattab, http://hakim.se

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.

vowel/static/plugins/tinymce/license.txt → LICENCES/tinymce View File


+ 7
- 0
LICENCES/uikit3 View File

@@ -0,0 +1,7 @@
Copyright (c) YOOtheme GmbH

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

+ 21
- 0
LICENCES/what-input View File

@@ -0,0 +1,21 @@
The MIT License (MIT)

Copyright (c) 2016 Jeremy Fields

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

+ 38
- 38
README.rst View File

@@ -12,41 +12,24 @@ initially for further education and
company training organisations.


ShortLog
========
ChangeLog
=========

See CHANGELOG.rst for full list of changes.


0.1.2 2015-11-03
----------------

Fix a scheduled function instance spawning itself (which spawns itself, etc).
Minor fixes in enrolment.


0.1.1 2015-11-01
----------------

Fix minor bugs.


0.1 2015-10-30
--------------

Initial version with most functionality.


Requirements
============

Software
--------

- PostgreSQL (9.4 or greater)
- MongoDB (2.6 recommended)
- Redis (2.6 or greater)
- Python 3 (3.4 or greater)
- PostgreSQL (9.5 or greater)
- Redis (3.2 or greater)
- Python 3 (3.5 or greater)
- LibreOffice (5.0 or greater)
- Poppler (poppler-glib 0.45 or greater)
- Python 3 GOBject

Hardware
--------
@@ -59,32 +42,48 @@ Hardware
Setup
=====

#. `mkvirtualenv vowel`
#. `git clone git@github.com:LapwingOrg/vowel.git && cd vowel`
#. `pip install -r requirements.txt`
#. `mkdir instance && cp config.py instance && nano instance/config.py`

virtualenv
----------

#. Ensure the software requirements above are met and running
#. ``mkvirtualenv vowel``
#. ``git clone git@github.com:LapwingOrg/vowel.git && cd vowel``
#. ``pip install -r requirements.txt``
#. ``mkdir instance && cp config.py instance && nano instance/config.py``

- Setup you configuation options here,
such as PostgreSQL connection, MongoDB connection, secret key, etc.
#. `python run.py first_run`
such as PostgreSQL connection, file upload location, secret key, etc.
#. ``FLASK_APP=$(pwd)/run.py flask first_run``

- Enter admin email and password.
#. `python run.py runserver`
#. Goto `http://127.0.0.1:5000` and login.
#. ``FLASK_APP=$(pwd)/run.py flask run``
#. Goto ``http://127.0.0.1:5000`` and login.
#. Background workers will not run unless started,
recommended that they are run in separate terminals

- ``source "./deployment/rq_settings.conf"``
- ``source "./instance/rq_settings.conf"``
- ``~/virtualenvs/vowel/bin/rqworker -u "${RQ_REDIS_URL}" high default low &``
- ``~/virtualenvs/vowel/bin/rqscheduler -u "${RQ_REDIS_URL}" &``


Testing
=======

#. `workon vowel && cd <PATH TO>/vowel`
#. `pip install -r requirements.testing.txt`
#. `nosetests -w testing/unittests`
virtualenv
----------

#. Ensure the software requirements above are met and running
#. ``workon vowel && cd <PATH TO>/vowel``
#. ``pip install -r requirements.testing.txt``
#. ``nosetests -w testing/unittests``


Licence
=======

Vowel is Copyright (C) 2015 Sam Black samwwwblack@lapwing.org.
Vowel is Copyright (C) 2015, 2016, 2017 Sam Black samwwwblack@lapwing.org.

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU Affero General Public License as published by
@@ -97,6 +96,7 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
GNU Affero General Public License for more details.

You should have received a copy of the GNU Affero General Public License
along with this program. If not, see http://www.gnu.org/licenses/.
along with this program.
If not, see `http://www.gnu.org/licenses/ <http://www.gnu.org/licenses/>`_.

Further licences are listed in the LICENCES directory.

+ 0
- 16
deployment/gunicorn.py View File

@@ -1,16 +0,0 @@
# coding=utf8
#
# gunicorn configuration file

# import multiprocessing

# Don't include the PID file path here
# as it is setup in the systemd file.

bind = "127.0.0.1:8008"
# Flask-SocketIO doesn't work with multiple workers
# workers = multiprocessing.cpu_count() * 2 + 1
workers = 1
worker_class = "eventlet"
daemon = False
chdir = "/home/vowel/vowel/"

+ 0
- 56
deployment/nginx.conf View File

@@ -1,56 +0,0 @@
upstream app_server {
server 127.0.0.1:8008 fail_timeout=0;
}

server {
listen 80;
server_name vowel.lapwing.org;

location / {
rewrite ^ https://$server_name$request_uri permanent;
}
}

server {
listen 443 ssl;
server_name vowel.lapwing.org;

client_max_body_size 4G;

access_log /var/log/nginx/vowel_lapwing_org.log;

location /static/ {
root /home/vowel/vowel/vowel;
}

location /favicon.ico {
alias /home/vowel/vowel/vowel/static/favicon.ico;
}

# Consonant please Carol.

location / {
proxy_pass http://app_server;

proxy_redirect off;

proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

location /socket.io {
proxy_pass http://app_server/socket.io;

proxy_redirect off;

proxy_set_header X-Real-IP $remote_addr;
proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
}

}

+ 0
- 10
deployment/rq_settings.conf View File

@@ -1,10 +0,0 @@
# coding=utf8
#
# Python-RQ settings file
# This is referenced in the systemd unit file,
# if you need local overrides,
# copy it to the instance directory
# and edit it there.

RQ_REDIS_URL="redis://localhost:6379/2"
SENTRY_DSN=""

+ 13
- 0
deployment/sponson/gunicorn.py View File

@@ -0,0 +1,13 @@
# coding=utf8
#
# gunicorn configuration file

# Don't include the PID file path here
# as it is setup in the systemd file.

bind = "127.0.0.1:5000"
workers = 1
worker_class = "eventlet"
daemon = False
chdir = "/srv/vowel/"
preload_app = True

+ 78
- 0
deployment/sponson/nginx.conf View File

@@ -0,0 +1,78 @@
user nginx;
worker_processes auto;
error_log syslog:server=unix:/dev/log;
pid /run/nginx.pid;

events {
worker_connections 1024;
}

http {
log_format main '$remote_addr - $remote_user [$time_local] "$request" '
'$status $body_bytes_sent "$http_referer" '
'"$http_user_agent" "$http_x_forwarded_for"';

access_log syslog:server=unix:/dev/log main;

sendfile on;
tcp_nopush on;
tcp_nodelay on;
keepalive_timeout 65;
types_hash_max_size 2048;

include /etc/nginx/mime.types;
default_type application/octet-stream;

# Load modular configuration files from the /etc/nginx/conf.d directory.
# See http://nginx.org/en/docs/ngx_core_module.html#include
# for more information.
include /etc/nginx/conf.d/*.conf;

upstream app_server {
server 127.0.0.1:5000 fail_timeout=0;
}

map $http_upgrade $connection_upgrade {
default upgrade;
'' close;
}

server {
listen 80;
listen [::]:80;
server_name vowel.lapwing.org;

client_max_body_size 4G;

location /static/ {
root /srv/vowel/vowel;
}

location /favicon.ico {
alias /srv/vowel/vowel/static/img/favicon.ico;
}

location /socket.io {
proxy_pass http://app_server/socket.io;

proxy_redirect off;

proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;

proxy_http_version 1.1;
proxy_set_header Upgrade $http_upgrade;
proxy_set_header Connection $connection_upgrade;
}

location / {
proxy_pass http://app_server;

proxy_redirect off;

proxy_set_header Host $host;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}

}
}

+ 10
- 0
deployment/sponson/rq_settings.conf View File

@@ -0,0 +1,10 @@
# coding=utf8
#
# Python-RQ settings file
# This is referenced in the systemd unit file,
# if you need local overrides,
# copy it to the instance directory
# and edit it there.

RQ_REDIS_URL="redis://redis:6379/1"
SENTRY_DSN=""

+ 15
- 0
deployment/sponson/systemd/vowel-rq_all@.service View File

@@ -0,0 +1,15 @@
[Unit]
Description=Vowel RQ All queues worker

[Service]
User=vowel
Group=vowel
WorkingDirectory=/srv/vowel
EnvironmentFile=/srv/vowel/deployment/sponson/rq_settings.conf
EnvironmentFile=-/srv/vowel/instance/rq_settings.conf
ExecStart=/usr/bin/rqworker -n all_%i high default low
Restart=on-failure
PrivateTmp=true

[Install]
WantedBy=multi-user.target

+ 15
- 0
deployment/sponson/systemd/vowel-rq_high@.service View File

@@ -0,0 +1,15 @@
[Unit]
Description=Vowel RQ High queue worker

[Service]
User=vowel
Group=vowel
WorkingDirectory=/srv/vowel
EnvironmentFile=/srv/vowel/deployment/sponson/rq_settings.conf
EnvironmentFile=-/srv/vowel/instance/rq_settings.conf
ExecStart=/usr/bin/rqworker -n high_%i high
Restart=on-failure
PrivateTmp=true

[Install]
WantedBy=multi-user.target

+ 15
- 0
deployment/sponson/systemd/vowel-rq_scheduler.service View File

@@ -0,0 +1,15 @@
[Unit]
Description=Vowel RQ scheduler worker

[Service]
User=vowel
Group=vowel
WorkingDirectory=/srv/vowel
EnvironmentFile=/srv/vowel/deployment/sponson/rq_settings.conf
EnvironmentFile=-/srv/vowel/instance/rq_settings.conf
ExecStart=/usr/bin/rqscheduler
Restart=on-failure
PrivateTmp=true

[Install]
WantedBy=multi-user.target

+ 20
- 0
deployment/sponson/systemd/vowel-runtime.service View File

@@ -0,0 +1,20 @@
[Unit]
Description=Vowel runtime gunicorn daemon
After=network.target

[Service]
PIDFile=/run/gunicorn/pid
User=vowel
Group=nginx
WorkingDirectory=/srv/vowel
EnvironmentFile=-/srv/vowel/instance/vowel_production.conf
# Define the PID here rather than the config file to keep it all neat.
ExecStart=/usr/bin/gunicorn --pid /run/gunicorn/pid -c /srv/vowel/deployment/sponson/gunicorn.py vowel.wsgi:app
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
Restart=on-failure
PrivateTmp=true
CPUShares=768

[Install]
WantedBy=multi-user.target

+ 15
- 0
deployment/sponson/systemd/vowel-soffice.service View File

@@ -0,0 +1,15 @@
[Unit]
Description=Vowel LibreOffice service

[Service]
PIDFile=/run/soffice.pid
User=vowel
Group=nginx
ExecStart=/usr/bin/soffice --accept="socket,host=localhost,port=8100;urp;StarOffice.Service" --headless --pidfile="/run/soffice.pid"
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
Restart=on-failure
PrivateTmp=true

[Install]
WantedBy=multi-user.target

+ 0
- 18
deployment/systemd/vowel-rq_all@.service View File

@@ -1,18 +0,0 @@
[Unit]
Description=Vowel RQ All queues worker
After=redis.service
Requires=redis.service

[Service]
User=vowel
Group=vowel
WorkingDirectory=/home/vowel/vowel
EnvironmentFile=/home/vowel/vowel/deployment/rq_settings.conf
EnvironmentFile=-/home/vowel/vowel/instance/rq_settings.conf
ExecStart=/home/vowel/venv/bin/rqworker -n all_%i high default low
Restart=on-failure
PrivateTmp=true
Slice=vowel.slice

[Install]
WantedBy=multi-user.target

+ 0
- 18
deployment/systemd/vowel-rq_high@.service View File

@@ -1,18 +0,0 @@
[Unit]
Description=Vowel RQ High queue worker
After=redis.service
Requires=redis.service

[Service]
User=vowel
Group=vowel
WorkingDirectory=/home/vowel/vowel
EnvironmentFile=/home/vowel/vowel/deployment/rq_settings.conf
EnvironmentFile=-/home/vowel/vowel/instance/rq_settings.conf
ExecStart=/home/vowel/venv/bin/rqworker -n high_%i high
Restart=on-failure
PrivateTmp=true
Slice=vowel.slice

[Install]
WantedBy=multi-user.target

+ 0
- 18
deployment/systemd/vowel-rq_scheduler.service View File

@@ -1,18 +0,0 @@
[Unit]
Description=Vowel RQ scheduler worker
After=redis.service
Requires=redis.service

[Service]
User=vowel
Group=vowel
WorkingDirectory=/home/vowel/vowel
EnvironmentFile=/home/vowel/vowel/deployment/rq_settings.conf
EnvironmentFile=-/home/vowel/vowel/instance/rq_settings.conf
ExecStart=/home/vowel/venv/bin/rqscheduler
Restart=on-failure
PrivateTmp=true
Slice=vowel.slice

[Install]
WantedBy=multi-user.target

+ 0
- 8
deployment/systemd/vowel.slice View File

@@ -1,8 +0,0 @@
[Unit]
Description=Vowel subservices slice
DefaultDependencies=no
Before=slices.target

[Slice]
CPUShares=1024
MemoryLimit=768M

+ 0
- 21
deployment/systemd/vowel_runtime.service View File

@@ -1,21 +0,0 @@
[Unit]
Description=Vowel runtime gunicorn daemon
After=network.target postgresql.service mongod.service redis.service
Requires=postgresql.service mongod.service redis.service

[Service]
PIDFile=/run/gunicorn/pid
User=vowel
Group=nginx
WorkingDirectory=/home/vowel/vowel
# Define the PID here rather than the config file to keep it all neat.
ExecStart=/home/vowel/venv/bin/python3-gunicorn --pid /run/gunicorn/pid -c /home/vowel/vowel/deployment/gunicorn.py vowel.wsgi:app
ExecReload=/bin/kill -s HUP $MAINPID
ExecStop=/bin/kill -s TERM $MAINPID
Restart=on-failure
PrivateTmp=true
Slice=vowel.slice
CPUShares=768

[Install]
WantedBy=multi-user.target

+ 2
- 0
deployment/tmpfiles.d/vowel-gunicorn.conf View File

@@ -0,0 +1,2 @@
d /run/gunicorn 0775 vowel nginx -
z /run/gunicorn 0775 vowel nginx -

+ 177
- 0
docs/developer/Makefile View File

@@ -0,0 +1,177 @@
# Makefile for Sphinx documentation
#

# You can set these variables from the command line.
SPHINXOPTS =
SPHINXBUILD = sphinx-build
PAPER =
BUILDDIR = _build

# User-friendly check for sphinx-build
ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
endif

# Internal variables.
PAPEROPT_a4 = -D latex_paper_size=a4
PAPEROPT_letter = -D latex_paper_size=letter
ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .
# the i18n builder cannot share the environment and doctrees with the others
I18NSPHINXOPTS = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) .

.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest gettext

help:
@echo "Please use \`make <target>' where <target> is one of"
@echo " html to make standalone HTML files"
@echo " dirhtml to make HTML files named index.html in directories"
@echo " singlehtml to make a single large HTML file"
@echo " pickle to make pickle files"
@echo " json to make JSON files"
@echo " htmlhelp to make HTML files and a HTML help project"
@echo " qthelp to make HTML files and a qthelp project"
@echo " devhelp to make HTML files and a Devhelp project"
@echo " epub to make an epub"
@echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
@echo " latexpdf to make LaTeX files and run them through pdflatex"
@echo " latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
@echo " text to make text files"
@echo " man to make manual pages"
@echo " texinfo to make Texinfo files"
@echo " info to make Texinfo files and run them through makeinfo"
@echo " gettext to make PO message catalogs"
@echo " changes to make an overview of all changed/added/deprecated items"
@echo " xml to make Docutils-native XML files"
@echo " pseudoxml to make pseudoxml-XML files for display purposes"
@echo " linkcheck to check all external links for integrity"
@echo " doctest to run all doctests embedded in the documentation (if enabled)"

clean:
rm -rf $(BUILDDIR)/*

html:
$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."

dirhtml:
$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
@echo
@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."

singlehtml:
$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
@echo
@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."

pickle:
$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
@echo
@echo "Build finished; now you can process the pickle files."

json:
$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
@echo
@echo "Build finished; now you can process the JSON files."

htmlhelp:
$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
@echo
@echo "Build finished; now you can run HTML Help Workshop with the" \
".hhp project file in $(BUILDDIR)/htmlhelp."

qthelp:
$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
@echo
@echo "Build finished; now you can run "qcollectiongenerator" with the" \
".qhcp project file in $(BUILDDIR)/qthelp, like this:"
@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/VowelDeveloper.qhcp"
@echo "To view the help file:"
@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/VowelDeveloper.qhc"

devhelp:
$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
@echo
@echo "Build finished."
@echo "To view the help file:"
@echo "# mkdir -p $$HOME/.local/share/devhelp/VowelDeveloper"
@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/VowelDeveloper"
@echo "# devhelp"

epub:
$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
@echo
@echo "Build finished. The epub file is in $(BUILDDIR)/epub."

latex:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo
@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
@echo "Run \`make' in that directory to run these through (pdf)latex" \
"(use \`make latexpdf' here to do that automatically)."

latexpdf:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through pdflatex..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

latexpdfja:
$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
@echo "Running LaTeX files through platex and dvipdfmx..."
$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."

text:
$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
@echo
@echo "Build finished. The text files are in $(BUILDDIR)/text."

man:
$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
@echo
@echo "Build finished. The manual pages are in $(BUILDDIR)/man."

texinfo:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo
@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
@echo "Run \`make' in that directory to run these through makeinfo" \
"(use \`make info' here to do that automatically)."

info:
$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
@echo "Running Texinfo files through makeinfo..."
make -C $(BUILDDIR)/texinfo info
@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."

gettext:
$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
@echo
@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."

changes:
$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
@echo
@echo "The overview file is in $(BUILDDIR)/changes."

linkcheck:
$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
@echo
@echo "Link check complete; look for any errors in the above output " \
"or in $(BUILDDIR)/linkcheck/output.txt."

doctest:
$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
@echo "Testing of doctests in the sources finished, look at the " \
"results in $(BUILDDIR)/doctest/output.txt."

xml:
$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
@echo
@echo "Build finished. The XML files are in $(BUILDDIR)/xml."

pseudoxml:
$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
@echo
@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 345
- 0
docs/developer/conf.py View File

@@ -0,0 +1,345 @@
#!/usr/bin/env python3
# -*- coding: utf-8 -*-
#
# Vowel Developer documentation build configuration file, created by
# sphinx-quickstart on Mon Dec 14 21:32:02 2015.
#
# This file is execfile()d with the current directory set to its
# containing dir.
#
# Note that not all possible configuration values are present in this
# autogenerated file.
#
# All configuration values have a default; values that are commented out
# serve to show the default.

import sys
import os

from datetime import date


this_year = date.today().year

# 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
# documentation root, use os.path.abspath to make it absolute, like shown here.
sys.path.insert(0, "/vagrant")
sys.path.insert(0, os.path.abspath("../../../vowel"))

# -- General configuration ------------------------------------------------

# If your documentation needs a minimal Sphinx version, state it here.
# needs_sphinx = "1.0"

# Add any Sphinx extension module names here, as strings. They can be
# extensions coming with Sphinx (named "sphinx.ext.*") or your custom
# ones.
extensions = [
"sphinx.ext.autodoc",
"sphinx.ext.todo",
"sphinx.ext.coverage",
"sphinx.ext.ifconfig",
"sphinx.ext.viewcode",
"sphinxcontrib.httpdomain",
"sphinxcontrib.autohttp.flask"
]

# Add any paths that contain templates here, relative to this directory.
templates_path = ["_templates"]

# The suffix of source filenames.
source_suffix = ".rst"

# The encoding of source files.
# source_encoding = "utf-8-sig"

# The master toctree document.
master_doc = "index"

# General information about the project.
project = "Vowel Developer"
copyright = "2015-{} Sam Black".format(this_year)

# The version info for the project you"re documenting, acts as replacement for
# |version| and |release|, also used in various other places throughout the
# built documents.
#
# The short X.Y version.
version = "0.1"
# The full version, including alpha/beta/rc tags.
release = "0.1.3"

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
# language = None

# There are two options for replacing |today|: either, you set today to some
# non-false value, then it is used:
# today = ""
# Else, today_fmt is used as the format for a strftime call.
# today_fmt = "%B %d, %Y"

# List of patterns, relative to source directory, that match files and
# directories to ignore when looking for source files.
exclude_patterns = ["_build"]

# The reST default role (used for this markup: `text`) to use for all
# documents.
# default_role = None

# If true, "()" will be appended to :func: etc. cross-reference text.
# add_function_parentheses = True

# If true, the current module name will be prepended to all description
# unit titles (such as .. function::).
# add_module_names = True

# If true, sectionauthor and moduleauthor directives will be shown in the
# output. They are ignored by default.
# show_authors = False

# The name of the Pygments (syntax highlighting) style to use.
pygments_style = "sphinx"

# A list of ignored prefixes for module index sorting.
# modindex_common_prefix = []

# If true, keep warnings as "system message" paragraphs in the built documents.
# keep_warnings = False

# If true, `todo` and `todoList` produce output, else they produce nothing.
todo_include_todos = True

# -- Options for HTML output ----------------------------------------------

# The theme to use for HTML and HTML Help pages. See the documentation for
# a list of builtin themes.
html_theme = "bizstyle"

# Theme options are theme-specific and customize the look and feel of a theme
# further. For a list of options available for each theme, see the
# documentation.
# html_theme_options = {}

# Add any paths that contain custom themes here, relative to this directory.
# html_theme_path = []

# The name for this set of Sphinx documents. If None, it defaults to
# "<project> v<release> documentation".
# html_title = None

# A shorter title for the navigation bar. Default is the same as html_title.
# html_short_title = None

# The name of an image file (relative to this directory) to place at the top
# of the sidebar.
# html_logo = None

# The name of an image file (within the static path) to use as favicon of the
# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
# pixels large.
# html_favicon = None

# Add any paths that contain custom static files (such as style sheets) here,
# relative to this directory. They are copied after the builtin static files,
# so a file named "default.css" will overwrite the builtin "default.css".
html_static_path = ["_static"]

# Add any extra paths that contain custom files (such as robots.txt or
# .htaccess) here, relative to this directory. These files are copied
# directly to the root of the documentation.
# html_extra_path = []

# If not "", a "Last updated on:" timestamp is inserted at every page bottom,
# using the given strftime format.
# html_last_updated_fmt = "%b %d, %Y"

# If true, SmartyPants will be used to convert quotes and dashes to
# typographically correct entities.
# html_use_smartypants = True

# Custom sidebar templates, maps document names to template names.
# html_sidebars = {}

# Additional templates that should be rendered to pages, maps page names to
# template names.
# html_additional_pages = {}

# If false, no module index is generated.
# html_domain_indices = True

# If false, no index is generated.
# html_use_index = True

# If true, the index is split into individual pages for each letter.
# html_split_index = False

# If true, links to the reST sources are added to the pages.
# html_show_sourcelink = True

# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
# html_show_sphinx = True

# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
# html_show_copyright = True

# If true, an OpenSearch description file will be output, and all pages will
# contain a <link> tag referring to it. The value of this option must be the
# base URL from which the finished HTML is served.
# html_use_opensearch = ""

# This is the file name suffix for HTML files (e.g. ".xhtml").
# html_file_suffix = None

# Output file base name for HTML help builder.
htmlhelp_basename = "VowelDeveloperdoc"

# -- Options for LaTeX output ---------------------------------------------

latex_elements = {
# The paper size ("letterpaper" or "a4paper").
# "papersize": "letterpaper",

# The font size ("10pt", "11pt" or "12pt").
# "pointsize": "10pt",

# Additional stuff for the LaTeX preamble.
# "preamble": "",
}

# Grouping the document tree into LaTeX files. List of tuples
# (source start file, target name, title,
# author, documentclass [howto, manual, or own class]).
latex_documents = [
("index", "VowelDeveloper.tex", "Vowel Developer Documentation",
"Sam Black", "manual"),
]

# The name of an image file (relative to this directory) to place at the top of
# the title page.
# latex_logo = None

# For "manual" documents, if this is true, then toplevel headings are parts,
# not chapters.
# latex_use_parts = False

# If true, show page references after internal links.
# latex_show_pagerefs = False

# If true, show URL addresses after external links.
# latex_show_urls = False

# Documents to append as an appendix to all manuals.
# latex_appendices = []

# If false, no module index is generated.
# latex_domain_indices = True


# -- Options for manual page output ---------------------------------------

# One entry per manual page. List of tuples
# (source start file, name, description, authors, manual section).
man_pages = [
("index", "voweldeveloper", "Vowel Developer Documentation",
["Sam Black"], 1)
]

# If true, show URL addresses after external links.
# man_show_urls = False


# -- Options for Texinfo output -------------------------------------------

# Grouping the document tree into Texinfo files. List of tuples
# (source start file, target name, title, author,
# dir menu entry, description, category)
texinfo_documents = [
("index", "VowelDeveloper", "Vowel Developer Documentation",
"Sam Black", "VowelDeveloper", "One line description of project.",
"Miscellaneous"),
]

# Documents to append as an appendix to all manuals.
# texinfo_appendices = []

# If false, no module index is generated.
# texinfo_domain_indices = True

# How to display URL addresses: "footnote", "no", or "inline".
# texinfo_show_urls = "footnote"

# If true, do not generate a @detailmenu in the "Top" node"s menu.
# texinfo_no_detailmenu = False


# -- Options for Epub output ----------------------------------------------

# Bibliographic Dublin Core info.
epub_title = "Vowel Developer"
epub_author = "Sam Black"
epub_publisher = "Sam Black"
epub_copyright = "2015-{} Sam Black".format(this_year)

# The basename for the epub file. It defaults to the project name.
# epub_basename = "Vowel Developer"

# The HTML theme for the epub output. Since the default themes are not
# optimized
# for small screen space, using the same theme for HTML and epub output is
# usually not wise. This defaults to "epub", a theme designed to save visual
# space.
# epub_theme = "epub"

# The language of the text. It defaults to the language option
# or en if the language is not set.
# epub_language = ""

# The scheme of the identifier. Typical schemes are ISBN or URL.
# epub_scheme = ""

# The unique identifier of the text. This can be a ISBN number
# or the project homepage.
# epub_identifier = ""

# A unique identification for the text.
# epub_uid = ""

# A tuple containing the cover image and cover page html template filenames.
# epub_cover = ()

# A sequence of (type, uri, title) tuples for the guide element of content.opf.
# epub_guide = ()

# HTML files that should be inserted before the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_pre_files = []

# HTML files shat should be inserted after the pages created by sphinx.
# The format is a list of tuples containing the path and title.
# epub_post_files = []

# A list of files that should not be packed into the epub file.
epub_exclude_files = ["search.html"]

# The depth of the table of contents in toc.ncx.
# epub_tocdepth = 3

# Allow duplicate toc entries.
# epub_tocdup = True

# Choose between "default" and "includehidden".
# epub_tocscope = "default"

# Fix unsupported image types using the PIL.
# epub_fix_images = False

# Scale large images.
# epub_max_image_width = 0

# How to display URL addresses: "footnote", "no", or "inline".
# epub_show_urls = "inline"

# If false, no index is generated.
# epub_use_index = True

+ 28
- 0
docs/developer/index.rst View File

@@ -0,0 +1,28 @@
=============================
Vowel Developer documentation
=============================

Vowel developer documentation covers

- Modules
- Views
- HTTP endpoints


Indices and tables
==================

.. toctree::
:name: mastertoc
:caption: Table of Contents
:maxdepth: 2
:titlesonly:

views/index.rst
utils/index.rst
models.rst


* :ref:`genindex`
* :ref:`modindex`
* :ref:`search`

+ 72
- 0
docs/developer/models.rst View File

@@ -0,0 +1,72 @@
Models
======

.. module:: vowel.models


Annotations
-----------

.. automodule:: vowel.models.annotation
:members:
:undoc-members:


Assessment
----------

.. automodule:: vowel.models.assessments
:members:
:undoc-members:


Course
------

.. automodule:: vowel.models.courses
:members:
:undoc-members:


Dashboard
---------

No models.


Lesson
------

.. automodule:: vowel.models.lessons
:members:
:undoc-members:


Organisation
------------

.. automodule:: vowel.models.organisations
:members:
:undoc-members:


Presentation
------------

No models.


Resources
---------

.. automodule:: vowel.models.resources
:members:
:undoc-members:


Users
-----

.. automodule:: vowel.models.users
:members:
:undoc-members:

+ 7
- 0
docs/developer/utils/forms.rst View File

@@ -0,0 +1,7 @@
Form utilities
==============

.. module:: vowel.forms.utils
.. automodule:: vowel.forms.utils
:members:
:undoc-members:

+ 12
- 0
docs/developer/utils/index.rst View File

@@ -0,0 +1,12 @@
Utilities
=========

Utilities used in Vowel.


.. toctree::
:maxdepth: 2
:titlesonly:

forms.rst
utils.rst

+ 68
- 0
docs/developer/utils/utils.rst View File

@@ -0,0 +1,68 @@
Utility functions
=================

.. module:: vowel.utils


Authentication
--------------

.. automodule:: vowel.utils.auth
:members:
:undoc-members:


Course
------

.. automodule:: vowel.utils.course
:members:
:undoc-members:


Enrolment
---------

.. automodule:: vowel.utils.enrolment
:members:
:undoc-members:


Mail
----

.. automodule:: vowel.utils.mail
:members:
:undoc-members:


Queue
-----

.. automodule:: vowel.utils.queue
:members:
:undoc-members:


Resources
---------

.. automodule:: vowel.utils.resources
:members:
:undoc-members:


Route
-----

.. automodule:: vowel.utils.route
:members:
:undoc-members:


Users
-----

.. automodule:: vowel.utils.user
:members:
:undoc-members:

+ 72
- 0
docs/developer/views/forms.rst View File

@@ -0,0 +1,72 @@
View forms
==========

.. module:: vowel.forms


Annotations
-----------

No annotation forms.


Assessment
----------

.. automodule:: vowel.forms.assessment
:members:
:undoc-members:


Course
------

.. automodule:: vowel.forms.course
:members:
:undoc-members:


Dashboard
---------

No dashboard forms.


Lesson
------

.. automodule:: vowel.forms.lesson
:members:
:undoc-members:


Organisation
------------

.. automodule:: vowel.forms.organisation
:members:
:undoc-members:


Presentation
------------

.. automodule:: vowel.forms.presentation
:members:
:undoc-members:


Resources
---------

.. automodule:: vowel.forms.resources
:members:
:undoc-members:


Users
-----

.. automodule:: vowel.forms.users
:members:
:undoc-members:

+ 14
- 0
docs/developer/views/index.rst View File

@@ -0,0 +1,14 @@
Views
=====

View related documentation, such as
view functions, forms and Flask endpoints.


.. toctree::
:maxdepth: 2
:titlesonly:

views.rst
forms.rst
rest.rst

+ 7
- 0
docs/developer/views/rest.rst View File

@@ -0,0 +1,7 @@
View endpoints
==============

.. autoflask:: vowel.web:create_app()
:undoc-static:
:undoc-blueprints: debugtoolbar, security
:undoc-endpoints: _debug_toolbar.static

+ 76
- 0
docs/developer/views/views.rst View File

@@ -0,0 +1,76 @@
View functions
==============

.. module:: vowel.views


Annotations
-----------

.. automodule:: vowel.views.annotations
:members:
:undoc-members:


Assessment
----------

.. automodule:: vowel.views.assessment
:members:
:undoc-members:


Course
------

.. automodule:: vowel.views.course
:members:
:undoc-members: