Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion .github/workflows/auto-add-to-project.yml
Original file line number Diff line number Diff line change
@@ -1,9 +1,12 @@
name: Auto Add Issues to Project
name: Auto Add Issues and Pull Requests to Project

on:
issues:
types:
- opened
pull_request_target:
types:
- opened

jobs:
# https://github.com/actions/add-to-project
Expand Down
2 changes: 0 additions & 2 deletions .github/workflows/test.yml
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@ jobs:
uses: actions/setup-python@v2
with:
python-version: 3.9
- name: Upgrade pip
run: python -m pip install --upgrade pip setuptools
- name: Install dependencies
run: |
pip install .[dev]
Expand Down
6 changes: 6 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,9 @@ __pycache__
*.egg-info/
/build/
/dist/
.DS_Store

### Editors ###
*~
/temp
/.vscode
87 changes: 78 additions & 9 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,68 +19,136 @@ instructions, because git commits are used to generate release notes:

<!-- scriv-insert-here -->

<a id='changelog-20.0.1'></a>
## v20.0.1 (2025-09-23)

- [Improvement] Make latex response editor background colours WCAG compliant in dark theme. (by @Danyal-Faheem)

- [Improvement] Sync footer in both MFE pages and templates (by @zubairshakoorarbisoft)

<a id='changelog-20.0.0'></a>

## v20.0.0 (2025-06-16)

- 💥[Feature] Upgrade to teak. (by @HammadYousaf01)

- [Bugfix] Remove reference to old account toggles. (by @ahmed-arb)

- [BugFix] Bump Indigo Header and Footer versions to fix image build failure due to React 18 upgrades in upstream MFEs (by @HammadYousaf01)

<a id='changelog-19.0.3'></a>

## v19.0.3 (2025-06-05)

- [Improvement] Fix multiple accessibility issues across the platform including screen reader compatibility, keyboard navigation, focus visibility, and WCAG compliance improvements. (by @arbirali and @zubairshakoorarbisoft)
- Add visible titles to image-based links for better screen reader support (#150)
- Make "Learn More" links accessible to screen readers (#151)
- Improve "Open Responses" table headers for keyboard accessibility (#152)
- Add accessible names to social media icons (#155)
- Enhance theme toggle with descriptive labels (#156)
- Increase focus visible thickness for better visibility (#158)
- Fix "Skip to main content" link display (#159)
- Resolve accessibility and reflow issues in Wiki, Teams, and Instructor Dashboard (#163)
- General accessibility fixes reported during review (#147)

<a id='changelog-19.0.2'></a>

## v19.0.2 (2025-05-27)

- [Improvement] Migrate from `setup.py` (setuptools) to `pyproject.toml` (hatch). (by @ahmed-arb)

- [Improvement] Add hatch_build.py in sdist target to fix the installation issues (by @dawoudsheraz)

- [BugFix] Fix runtime footer import error in env.config.jsx for unsupported MFEs. (by @ahmed-arb)

- [BugFix] Maintain selected emoji color in survey xblock. (by @mlabeeb03)

- [Improvement] Change color of headings and list items in dark mode to improve readability. (by @mlabeeb03)

<a id='changelog-19.0.1'></a>

## v19.0.1 (2025-01-26)

- [BugFix] Fix env.config.jsx for dark theme and Indigo footer by including the patches folder in MANIFEST.in for python pypi package. (by @hinakhadim)

<a id='changelog-19.0.0'></a>

## v19.0.0 (2024-12-11)

- 💥[Feature] Upgrade to Sumac (by @hinakhadim)

<a id='changelog-18.3.0'></a>

## v18.3.0 (2024-12-11)

- 💥 [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @hinakhadim)
- 💥[Improvement] Rename Tutor's two branches (by @DawoudSheraz):
* Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
* Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
- Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
- Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
- [Bugfix] Fix dropdown select rendering issue on light theme (by @dawoudsheraz)
- ".wrapper-problem-response" did not need any dark theme variables outside dark-theme class for dropdown problems. This was causing the dropdown to use dark theme variables regardless of the theme that user selected.
- ".wrapper-problem-response" did not need any dark theme variables outside dark-theme class for dropdown problems. This was causing the dropdown to use dark theme variables regardless of the theme that user selected.
- [Bugfix] Add dark-theme for Course Handouts and Course Updates that appears on Learning MFE Course Outline Page (by @hinakhadim)
- [Bugfix] Update dark-theme styles for ORA (Open Response Assessment) so that it becomes readable, usable, beautiful, and appealing (by @hinakhadim)
- The readability of styles in the `scss` file is challenging and will be improved in subsequent releases.
- The readability of styles in the `scss` file is challenging and will be improved in subsequent releases.
- [Bugfix] Fix various dark theme issues with Teams tab on LMS. (by @dawoudsheraz)
- [Bugfix] Update dark-theme styles for Notes and Textbook Page (by @hinakhadim)

<a id='changelog-18.2.2'></a>

## v18.2.2 (2024-10-29)

- [Feature] Upgrade upstream apps to open-release/redwood.3. In particular, this will resolve serious issues with [course creation](https://github.com/openedx/frontend-app-authoring/issues/1199) and [language switching](https://github.com/openedx/frontend-app-account/issues/1052). (by @regisb)

<a id='changelog-18.2.1'></a>

## v18.2.1 (2024-10-11)

- [Feature] Introduced theme toggle feature with enable/disable option and runtime switch between light and dark modes. (by @hinakhadim)

<a id='changelog-18.1.1'></a>

## v18.1.1 (2024-08-27)

- [BugFix] Add the Indigo footer in MFEs via env.config.jsx to resolve display issues on the /account/ page after upgrading to Redwood. (by @hinakhadim)

<a id='changelog-18.1.0'></a>

## v18.1.0 (2024-07-23)

- [Improvement] Instead of forcing users to use Authentication MFe, the platform decides how users should log in. (by @CodeWithEmad)

- [Feature] Dark theme: the Indigo theme now covers dark theme for LMS pages, including the MFEs, and they are more beautiful! (by @tanveer65 and @hinakhadim)
- [Feature] Dark theme: the Indigo theme now covers dark theme for LMS pages, including the MFEs, and they are more beautiful! (by @tanveer65 and @hinakhadim)

<a id='changelog-18.0.0'></a>

## v18.0.0 (2024-06-20)

- 💥[Feature] Upgrade to Redwood (by @hinakhadim)

<a id='changelog-17.4.2'></a>

## v17.4.2 (2024-06-11)

- [BugFix] Add big screen variable of screen responsiveness (by @tanveer65)

<a id='changelog-17.4.1'></a>

## v17.4.1 (2024-06-10)

- [BugFix] Remove undefined variables of dark-theme. (by @hinakhadim)

<a id='changelog-17.4.0'></a>

## v17.4.0 (2024-06-10)

- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)

- [Bugfix] *.scss files in cms directory were not rendered in the tutor environment because they are stored in a "partials" subdirectory. (by @Talha-Rizwan)
- [Bugfix] \*.scss files in cms directory were not rendered in the tutor environment because they are stored in a "partials" subdirectory. (by @Talha-Rizwan)

- [Improvement] Add styles for Profile and Account MFE and increase container width for better readability. (by @tanveer65)

<a id='changelog-17.3.0'></a>

## v17.3.0 (2024-03-04)

- 💥[Improvement] Allow the no_course_image.png image to pull from the current theme, not specifically named indigo (by @misilot)
Expand All @@ -90,20 +158,21 @@ instructions, because git commits are used to generate release notes:
- [Improvement] Style static pages of About, Contact, Privacy and bookmarks page (by @tanveer65)

<a id='changelog-17.2.0'></a>

## v17.2.0 (2024-01-27)

- 💥[Bugfix] Fixes: Minor Bug fixes with styling updates for discussion and learner-dashboard MFEs (by @hinakhadim and @TanveerAhmed)

<a id='changelog-17.1.0'></a>

## v17.1.0 (2023-12-13)

- 💥[Improvement] Complete overhaul and redesign: the Indigo theme now covers more pages, including the MFE footer and header, and they are more beautiful than ever! (by @hinakhadim and @TanveerAhmed)

<a id='changelog-17.0.0'></a>

## v17.0.0 (2023-12-09)

- 💥[Feature] Upgrade to Quince (by @hinakhadim)
- [Improvement] Add a scriv-compliant changelog. (by @regisb)
- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad)


- [Improvement] Added Makefile and test action to repository and formatted code with Black and isort. (by @CodeWithEmad)
1 change: 0 additions & 1 deletion MANIFEST.in

This file was deleted.

6 changes: 3 additions & 3 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -86,11 +86,11 @@ Overriding the default "about", "contact", etc. static pages

By default, the ``/about`` and ``/contact`` pages contain a simple line of text: "This page left intentionally blank. Feel free to add your own content". This is of course unusable in production. In the following, we detail how to override just any of the static templates used in Open edX.

The static templates used by Open edX to render those pages are all stored in the `edx-platform/lms/templates/static_templates <https://github.com/edx/edx-platform/tree/open-release/redwood.master/lms/templates/static_templates>`__ folder. To override those templates, you should add your own in the following folder::
The static templates used by Open edX to render those pages are all stored in the `edx-platform/lms/templates/static_templates <https://github.com/edx/edx-platform/tree/open-release/sumac.master/lms/templates/static_templates>`__ folder. To override those templates, you should add your own in the following folder::

ls tutorindigo/templates/indigo/lms/templates/static_templates"

For instance, edit the "donate.html" file in this directory. We can derive the content of this file from the contents of the `donate.html <https://github.com/edx/edx-platform/blob/open-release/redwood.master/lms/templates/static_templates/donate.html>`__ static template in edx-platform:
For instance, edit the "donate.html" file in this directory. We can derive the content of this file from the contents of the `donate.html <https://github.com/edx/edx-platform/blob/open-release/sumac.master/lms/templates/static_templates/donate.html>`__ static template in edx-platform:

.. code-block:: mako

Expand Down Expand Up @@ -131,7 +131,7 @@ The indigo theme can’t override styles for MFEs directly. It overrides the sty
))


This Tutor plugin is maintained by Hina Khadim from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
This Tutor plugin is maintained by Ahmed Khalid and Hammad Yousaf from `Edly <https://edly.io>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.


License
Expand Down
68 changes: 67 additions & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,2 +1,68 @@
#https://hatch.pypa.io/latest/config/build/

[project]
name = "tutor-indigo"
description = "Indigo theme plugin for Tutor"
readme = { file = "README.rst", content-type = "text/x-rst" }
license = { text = "AGPLv3" }
requires-python = ">=3.9"
authors = [{ name = "Edly" }, { email = "hello@edly.io" }]
maintainers = [
{ name = "Ahmed Khalid" }, { email = "ahmed.khalid@arbisoft.com" },
{ name = "Hammad Yousaf" }, { email = "hammad.yousaf@arbisoft.com" }
]
classifiers = [
"Development Status :: 5 - Production/Stable",
"Intended Audience :: Developers",
"License :: OSI Approved :: GNU Affero General Public License v3",
"Operating System :: OS Independent",
"Programming Language :: Python",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: 3.11",
"Programming Language :: Python :: 3.12",
]
dependencies = [
"tutor-mfe>=20.0.0,<21.0.0",
"tutor>=20.0.0,<21.0.0"
]

# hatch_build.py will set it later
dynamic = ["version"]

[project.optional-dependencies]
dev = [
"tutor[dev]>=20.0.0,<21.0.0",
"pylint",
"black"
]

[project.entry-points."tutor.plugin.v1"]
indigo = "tutorindigo.plugin"

[project.urls]
Code = "https://github.com/overhangio/tutor-indigo"
Community = "https://discuss.openedx.org"
Documentation = "https://docs.tutor.edly.io/"
Homepage = "https://github.com/overhangio/tutor-indigo"
Changelog = "https://github.com/overhangio/tutor-indigo/blob/release/CHANGELOG.md"
Issues = "https://github.com/overhangio/tutor-indigo/issues"

# hatch related configurations
[build-system]
requires = ["setuptools", "wheel"]
requires = ["hatchling"]
build-backend = "hatchling.build"

[tool.hatch.build.targets.sdist]
# Disable strict naming, otherwise twine is not able to detect name/version
strict-naming = false
include = ["/tutorindigo", ".hatch_build.py"]
exclude = ["tests*"]

# we need this becuase our project escapes default hatch file selection.
# see https://hatch.pypa.io/latest/plugins/builder/wheel/#default-file-selection
[tool.hatch.build.targets.wheel]
packages = ["/tutorindigo"]

[tool.hatch.metadata.hooks.custom]
path = ".hatch_build.py"
62 changes: 0 additions & 62 deletions setup.py

This file was deleted.

2 changes: 1 addition & 1 deletion tutorindigo/__about__.py
Original file line number Diff line number Diff line change
@@ -1 +1 @@
__version__ = "18.3.0"
__version__ = "20.0.1"
Loading