feat: upgrade to Quince

This commit is contained in:
jfavellar90 2023-11-14 19:46:35 -05:00 committed by Régis Behmo
parent 0751918e6a
commit 0d0128210c
9 changed files with 20 additions and 14 deletions

View File

@ -2,7 +2,7 @@ variables:
TUTOR_PLUGIN: notes TUTOR_PLUGIN: notes
TUTOR_IMAGES: notes TUTOR_IMAGES: notes
TUTOR_PYPI_PACKAGE: tutor-notes TUTOR_PYPI_PACKAGE: tutor-notes
OPENEDX_RELEASE: palm OPENEDX_RELEASE: quince
GITHUB_REPO: overhangio/tutor-notes GITHUB_REPO: overhangio/tutor-notes
include: include:

View File

@ -19,3 +19,12 @@ instructions, because git commits are used to generate release notes:
<!-- scriv-insert-here --> <!-- scriv-insert-here -->
<a id='changelog-17.0.0'></a>
## v17.0.0 (2023-12-09)
- 💥 [Feature] Upgrade to Quince.
- [Improvement] Add a scriv-compliant changelog. (by @regisb)
- [Improvement] Removing the notes permissions container in favor of a global single permissions container. (by @jfavellar90)
- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad)

View File

@ -1,9 +1,9 @@
Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_ Students notes plugin for `Tutor <https://docs.tutor.edly.io>`_
=================================================================== ===================================================================
This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/exercises_tools/notes.html>`_). This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ to easily add the `Open edX note-taking app <https://github.com/openedx/edx-notes-api>`_ to an Open edX platform. This app allows students to annotate portions of the courseware (see `the official documentation <https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-quince.master/exercises_tools/notes.html>`_).
.. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-palm.master/_images/SFD_SN_bodyexample.png .. image:: https://edx.readthedocs.io/projects/open-edx-building-and-running-a-course/en/open-release-quince.master/_images/SFD_SN_bodyexample.png
:alt: Notes in action :alt: Notes in action
Installation Installation

View File

@ -1 +0,0 @@
- [Improvement] Add a scriv-compliant changelog. (by @regisb)

View File

@ -1 +0,0 @@
- [Improvement] Removing the notes permissions container in favor of a global single permissions container. (by @jfavellar90)

View File

@ -1 +0,0 @@
- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad)

View File

@ -32,8 +32,8 @@ setup(
packages=find_packages(exclude=["tests*"]), packages=find_packages(exclude=["tests*"]),
include_package_data=True, include_package_data=True,
python_requires=">=3.8", python_requires=">=3.8",
install_requires=["tutor>=16.0.0,<17.0.0"], install_requires=["tutor>=17.0.0,<18.0.0"],
extras_require={"dev": ["tutor[dev]>=16.0.0,<17.0.0"]}, extras_require={"dev": ["tutor[dev]>=17.0.0,<18.0.0"]},
entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]}, entry_points={"tutor.plugin.v1": ["notes = tutornotes.plugin"]},
classifiers=[ classifiers=[
"Development Status :: 5 - Production/Stable", "Development Status :: 5 - Production/Stable",

View File

@ -1 +1 @@
__version__ = "16.0.2" __version__ = "17.0.0"

View File

@ -1,9 +1,9 @@
{% if is_buildkit_enabled() %}# syntax=docker/dockerfile:1.4{% endif %} # syntax=docker/dockerfile:1.4
FROM docker.io/ubuntu:20.04 FROM docker.io/ubuntu:20.04
ENV DEBIAN_FRONTEND=noninteractive ENV DEBIAN_FRONTEND=noninteractive
RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \ RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
--mount=type=cache,target=/var/lib/apt,sharing=locked{% endif %} \ --mount=type=cache,target=/var/lib/apt,sharing=locked \
apt update && \ apt update && \
apt upgrade -y && \ apt upgrade -y && \
apt install -y \ apt install -y \
@ -30,8 +30,8 @@ ENV PATH /app/venv/bin:${PATH}
# https://pypi.org/project/setuptools/ # https://pypi.org/project/setuptools/
# https://pypi.org/project/pip/ # https://pypi.org/project/pip/
# https://pypi.org/project/wheel/ # https://pypi.org/project/wheel/
RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install setuptools==67.8.0 pip==23.1.2 wheel==0.40.0 RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install setuptools==68.2.2 pip==23.2.1 wheel==0.41.2
RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/app/.cache/pip,sharing=shared {% endif %}pip install -r requirements/base.txt RUN --mount=type=cache,target=/app/.cache/pip,sharing=shared pip install -r requirements/base.txt
EXPOSE 8000 EXPOSE 8000
CMD gunicorn --workers=2 --name notes --bind=0.0.0.0:8000 --max-requests=1000 notesserver.wsgi:application CMD gunicorn --workers=2 --name notes --bind=0.0.0.0:8000 --max-requests=1000 notesserver.wsgi:application