Skip to content

Commit eaa573b

Browse files
kdmccormickclaude
andcommitted
feat!: Rename tutor->tutor-contrib-sample ; tutorsampleplugin->tutorsample
Why? This follows existing widely used tutor plugin naming conventions. Co-Authored-By: Claude Opus 4.7 <noreply@anthropic.com>
1 parent 9f7efff commit eaa573b

8 files changed

Lines changed: 13 additions & 13 deletions

File tree

.github/workflows/release.yml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,14 +69,14 @@ jobs:
6969
# setuptools-scm picks it up at build time.
7070
if: steps.release.outputs.released == 'true'
7171
run: pip install build && SETUPTOOLS_SCM_PRETEND_VERSION=${{ steps.release.outputs.version }} python -m build
72-
working-directory: './tutor'
72+
working-directory: './tutor-contrib-sample'
7373

7474
- name: Upload | Tutor Plugin Distribution Artifacts
7575
uses: actions/upload-artifact@v4
7676
if: steps.release.outputs.released == 'true'
7777
with:
7878
name: tutor-distribution-artifacts
79-
path: tutor/dist
79+
path: tutor-contrib-sample/dist
8080
if-no-files-found: error
8181

8282
outputs:
@@ -125,12 +125,12 @@ jobs:
125125
uses: actions/download-artifact@v4
126126
with:
127127
name: tutor-distribution-artifacts
128-
path: tutor/dist
128+
path: tutor-contrib-sample/dist
129129

130130
- name: Publish to PyPi
131131
uses: pypa/gh-action-pypi-publish@release/v1
132132
with:
133-
packages-dir: tutor/dist
133+
packages-dir: tutor-contrib-sample/dist
134134
user: __token__
135135
password: ${{ secrets.PYPI_UPLOAD_TOKEN }}
136136

CLAUDE.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ This is a **sample plugin repository** that demonstrates all major Open edX plug
1515
**Repository Structure:**
1616
- `platform-plugin-sample/` - Django app plugin with models, APIs, events, and filters
1717
- `frontend-plugin-sample/` - React component for MFE slot customization
18-
- `tutor/` - Tutor plugin for easy deployment
18+
- `tutor-contrib-sample/` - Tutor plugin for easy deployment
1919
- Each directory has comprehensive README.md files with TOCs
2020

2121
**When Making Changes:**
@@ -31,7 +31,7 @@ This is a **sample plugin repository** that demonstrates all major Open edX plug
3131
- `platform-plugin-sample/openedx_sample_plugin/models.py` - CourseArchiveStatus model (business logic)
3232
- `platform-plugin-sample/openedx_sample_plugin/views.py` - REST API endpoints consumed by frontend
3333
- `frontend-plugin-sample/src/plugin.jsx` - React component that replaces course list slot
34-
- `tutor/openedx_sample_plugin.py` - Deployment configuration (currently basic template)
34+
- `tutor-contrib-sample/tutorsample/plugin.py` - Deployment configuration (currently basic template)
3535

3636
## Build/Lint/Test Commands
3737
- Make sure to set the following so that test output is not too verbose: `export PYTEST_ADDOPTS="--disable-warnings --no-header --tb=short"`

README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ This sample plugin showcases the **Open edX Hooks Extension Framework**, which a
3434
| **Filters** | Modify platform behavior | [Using Open edX Filters](https://docs.openedx.org/projects/openedx-filters/en/latest/how-tos/using-filters.html) | [`platform-plugin-sample/openedx_sample_plugin/pipeline.py`](./platform-plugin-sample/openedx_sample_plugin/pipeline.py) | Customizing business logic, URL redirects |
3535
| **Frontend Slots** | Customize MFE interfaces | [Frontend Plugin Slots](https://docs.openedx.org/en/latest/site_ops/how-tos/use-frontend-plugin-slots.html) | [`frontend-plugin-sample/`](./frontend-plugin-sample/) | UI customization, adding new components |
3636
| **Brand Packages** | Customize theming | [Open edX Brand Package Interface](https://github.com/openedx/brand-openedx) | [`brand/`](./brand/) | UI theming |
37-
| **Tutor Plugin** | Deploy plugins easily | [Tutor Plugin Development](https://docs.tutor.edly.io/) | [`tutor/`](./tutor/) | Simplified deployment and configuration |
37+
| **Tutor Plugin** | Deploy plugins easily | [Tutor Plugin Development](https://docs.tutor.edly.io/) | [`tutor-contrib-sample/`](./tutor-contrib-sample/) | Simplified deployment and configuration |
3838

3939
## Quick Start Guide
4040

@@ -124,7 +124,7 @@ sample-plugin/
124124
│ │ ├── plugin.jsx # React component for MFE slot
125125
│ │ └── index.jsx # Export configuration
126126
│ └── package.json # NPM package configuration
127-
└── tutor/
127+
└── tutor-contrib-sample/
128128
├── README.md # Tutor deployment guide
129129
└── openedx_sample_plugin.py # Tutor plugin configuration
130130
```

frontend-plugin-sample/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -420,7 +420,7 @@ Test within the actual MFE environment:
420420

421421
### Production Deployment with Tutor
422422

423-
**Tutor Plugin Configuration** (see [`../tutor/README.md`](../tutor/README.md)):
423+
**Tutor Plugin Configuration** (see [`../tutor-contrib-sample/README.md`](../tutor-contrib-sample/README.md)):
424424

425425
```python
426426
# In tutor plugin
Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -122,7 +122,7 @@ PLUGIN_SLOTS.add_items([
122122

123123
```bash
124124
# Method 1: Install from local directory
125-
pip install -e /path/to/sample-plugin/tutor/
125+
pip install -e /path/to/sample-plugin/tutor-contrib-sample/
126126

127127
# Method 2: Copy plugin file (simpler for development)
128128
mkdir -p "$(tutor plugins printroot)"
Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ requires = ["setuptools", "setuptools-scm>8.1"]
33
build-backend = "setuptools.build_meta"
44

55
[project]
6-
name = "tutor-contrib-sample-plugin"
6+
name = "tutor-contrib-sample"
77
description = "Tutor plugin for the Open edX Sample Plugin"
88
requires-python = ">=3.11"
99
license = "Apache-2.0"
@@ -23,7 +23,7 @@ dependencies = ["tutor>=17.0.0"]
2323
dynamic = ["readme", "version"]
2424

2525
[project.entry-points."tutor.plugin.v1"]
26-
openedx_sample_plugin = "tutorsampleplugin.plugin"
26+
sample = "tutorsample.plugin"
2727

2828
[project.urls]
2929
Homepage = "https://github.com/openedx/sample-plugin"
@@ -34,7 +34,7 @@ readme = {file = ["README.md"], content-type = "text/markdown"}
3434

3535
[tool.setuptools.packages.find]
3636
where = ["."]
37-
include = ["tutorsampleplugin*"]
37+
include = ["tutorsample*"]
3838

3939
[tool.setuptools_scm]
4040
# The root for the git repo is one directory up.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)