# nb_extension_empinken
Jupyter notebook extension for background colouring selected cells.
[](https://mybinder.org/v2/gh/innovationOUtside/nb_extension_empinken/master)
Install the latest version from the default branch in this repository:
`pip install --upgrade git+https://github.com/innovationOUtside/nb_extension_empinken.git`
Or from a particular branch (eg the `BRANCH` branch):
`pip install --upgrade git+https://github.com/innovationOUtside/nb_extension_empinken.git@BRANCH`
Install a released version from PyPi:
`pip install nb-extension-empinken`
The extension should be automatically installed and enabled.
If you need to do things manually:
```
jupyter nbextension uninstall empinken
jupyter nbextension install empinken --user
jupyter nbextension enable empinken/index
```
Four buttons are defined provided that toggle the colour of selected code or markdown cells:
- activity cells (blue);
- student annotation cells (yellow);
- tutor feedback cells (pink);
- solution cells (green).
From the `nbextesions_configurator` panel, you can control which buttons are selected and what colour styling is applied:
When cells are toggled, a tag is set on them that is used to apply the styling:
Currently, the following tags are used; <s>`style_activity`, `style_solution`, `style_student` `style_commentate`</s> UPDATED TO: `style-activity`, `style-solution`, `style-student` `style-commentate`
## History
Originally developed in support the OU distance education course *TM351 Data Management and Analysis*, the extension provides toolbar buttons that highlight selected cells with particular background colours.
The extension broke after a year or two of use, but has been patched and made more customisable since then.
The original use case allowed course material authors to style activity related cells with a blue colour theme, matching the convention used in online VLE materials.
A pink colour was used in production by the course team to highlight prodcution related course team discussions in notebooks, or cells that contained errors.
The pink colouring button was used by tutors during course presentation (i.e. in support of direct teaching) to colour feedback cells they had added to students' marked work. Somewhere along the line, the feature came to be known as "empinken"...
The updated version of the extension also includes a yellow cell highlight, that I think can be used in at least two ways:
- firstly, as an activity prompt to students in provided materials that they need to write something in the notebook as part of the activity;
- secondly, as a way for students to highlight cells that they have added to the notebook to distinguish them from content that came with the original notebook.
The green solution styling was added in response to a module team request for a style that could be used to distinguish solution cells.
## Future Considerations
The extension could be generalised to allow particular notebook cell tags to be used to identify cells that should be coloured in particular ways. So e.g. in configurator, associate the tag "activity" with a selected blue etc. See the related [`nb_extension_tagstyler`](https://github.com/innovationOUtside/nb_extension_tagstyler) extension that explores how to use cell tags to invoke the application of Bootstrap `alert` styling to correspondingly tagged cells.
Maybe also consider a setting that would colour all student created cells yellow (or whatever) by hooking something on to the notebook's cell add button to tag cells as `contributed`? Or use a pre-distribution step to tag all cells in notebooks provided to students as `distributed`?
Better support for hidden/revealable solutions in activities is an ongoing consideration. Basing this around appropriate tags would seem to be a sensible approach,
Raw data
{
"_id": null,
"home_page": "https://github.com/innovationOUtside/nb_extension_empinken",
"name": "nb-extension-empinken",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Tony Hirst",
"author_email": "tony.hirst@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/b7/ee/7aee659aa32c3910917dc4876154bf0a5988c8ce8bd1b54a0c3aeb1265b6/nb_extension_empinken-0.0.7.tar.gz",
"platform": null,
"description": "# nb_extension_empinken\nJupyter notebook extension for background colouring selected cells.\n\n[](https://mybinder.org/v2/gh/innovationOUtside/nb_extension_empinken/master)\n\nInstall the latest version from the default branch in this repository:\n\n`pip install --upgrade git+https://github.com/innovationOUtside/nb_extension_empinken.git`\n\nOr from a particular branch (eg the `BRANCH` branch):\n\n`pip install --upgrade git+https://github.com/innovationOUtside/nb_extension_empinken.git@BRANCH`\n\nInstall a released version from PyPi:\n\n`pip install nb-extension-empinken`\n\nThe extension should be automatically installed and enabled.\n\nIf you need to do things manually:\n\n\n```\njupyter nbextension uninstall empinken\njupyter nbextension install empinken --user\njupyter nbextension enable empinken/index\n```\n\n\nFour buttons are defined provided that toggle the colour of selected code or markdown cells:\n\n- activity cells (blue);\n- student annotation cells (yellow);\n- tutor feedback cells (pink);\n- solution cells (green).\n\n\n\n\nFrom the `nbextesions_configurator` panel, you can control which buttons are selected and what colour styling is applied:\n\n\n\n\nWhen cells are toggled, a tag is set on them that is used to apply the styling:\n\n\n\nCurrently, the following tags are used; <s>`style_activity`, `style_solution`, `style_student` `style_commentate`</s> UPDATED TO: `style-activity`, `style-solution`, `style-student` `style-commentate`\n\n\n## History\n\nOriginally developed in support the OU distance education course *TM351 Data Management and Analysis*, the extension provides toolbar buttons that highlight selected cells with particular background colours.\n\nThe extension broke after a year or two of use, but has been patched and made more customisable since then.\n\nThe original use case allowed course material authors to style activity related cells with a blue colour theme, matching the convention used in online VLE materials.\n\nA pink colour was used in production by the course team to highlight prodcution related course team discussions in notebooks, or cells that contained errors.\n\nThe pink colouring button was used by tutors during course presentation (i.e. in support of direct teaching) to colour feedback cells they had added to students' marked work. Somewhere along the line, the feature came to be known as \"empinken\"... \n\nThe updated version of the extension also includes a yellow cell highlight, that I think can be used in at least two ways:\n\n- firstly, as an activity prompt to students in provided materials that they need to write something in the notebook as part of the activity;\n- secondly, as a way for students to highlight cells that they have added to the notebook to distinguish them from content that came with the original notebook.\n\nThe green solution styling was added in response to a module team request for a style that could be used to distinguish solution cells.\n\n\n## Future Considerations\n\nThe extension could be generalised to allow particular notebook cell tags to be used to identify cells that should be coloured in particular ways. So e.g. in configurator, associate the tag \"activity\" with a selected blue etc. See the related [`nb_extension_tagstyler`](https://github.com/innovationOUtside/nb_extension_tagstyler) extension that explores how to use cell tags to invoke the application of Bootstrap `alert` styling to correspondingly tagged cells.\n\nMaybe also consider a setting that would colour all student created cells yellow (or whatever) by hooking something on to the notebook's cell add button to tag cells as `contributed`? Or use a pre-distribution step to tag all cells in notebooks provided to students as `distributed`?\n\nBetter support for hidden/revealable solutions in activities is an ongoing consideration. Basing this around appropriate tags would seem to be a sensible approach,\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Empinken cell background colouring for class and nbclassic Jupyter notebooks.",
"version": "0.0.7",
"project_urls": {
"Homepage": "https://github.com/innovationOUtside/nb_extension_empinken"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b2595c212690b60b4a7a0cdfd6209f6f3252f3fcf8112cdcfc1639edcad78e77",
"md5": "13aea9ac0ef71c6969d299d7356b7f7f",
"sha256": "cdde8a76034ffeb2fa6c97d864f2af22f1dfe922f5b5b2526273608d1459f279"
},
"downloads": -1,
"filename": "nb_extension_empinken-0.0.7-py3-none-any.whl",
"has_sig": false,
"md5_digest": "13aea9ac0ef71c6969d299d7356b7f7f",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10742,
"upload_time": "2023-09-14T14:36:08",
"upload_time_iso_8601": "2023-09-14T14:36:08.391943Z",
"url": "https://files.pythonhosted.org/packages/b2/59/5c212690b60b4a7a0cdfd6209f6f3252f3fcf8112cdcfc1639edcad78e77/nb_extension_empinken-0.0.7-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b7ee7aee659aa32c3910917dc4876154bf0a5988c8ce8bd1b54a0c3aeb1265b6",
"md5": "c439af1ae5f937f36f0d109f6539263e",
"sha256": "9d8c193383e908c2bcef820722755bcb60604ca294f79689a806ebab97c071b7"
},
"downloads": -1,
"filename": "nb_extension_empinken-0.0.7.tar.gz",
"has_sig": false,
"md5_digest": "c439af1ae5f937f36f0d109f6539263e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8633,
"upload_time": "2023-09-14T14:36:09",
"upload_time_iso_8601": "2023-09-14T14:36:09.328431Z",
"url": "https://files.pythonhosted.org/packages/b7/ee/7aee659aa32c3910917dc4876154bf0a5988c8ce8bd1b54a0c3aeb1265b6/nb_extension_empinken-0.0.7.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-09-14 14:36:09",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "innovationOUtside",
"github_project": "nb_extension_empinken",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "nb-extension-empinken"
}
JSON
