Skip to content

Commit 6d0dfb6

Browse files
committed
build: Fix up some build settings and add docs.
Make it so we're building against Djngo 4.2 and 5.2 and add some docs for development with Tutor
1 parent 0064901 commit 6d0dfb6

File tree

4 files changed

+25
-5
lines changed

4 files changed

+25
-5
lines changed

CLAUDE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,4 +18,4 @@ This file provides guidance to Claude Code (claude.ai/code) when working with co
1818
- Use pytest for testing, with descriptive test function names
1919
- Frontend uses React and follows standard JSX conventions
2020

21-
Always run `make quality` before creating a PR to ensure consistent code style.
21+
Always run `make quality` and fix issues before creating a PR to ensure consistent code style.

README.md

Lines changed: 20 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,9 @@ export default config;
7474
## Add a module.config.js
7575

7676
This file tells webpack to use your local repo for the code of the module rather
77-
than the `npm install` version of your package.
77+
than the `npm install` version of your package. It's still necessary to do the
78+
`npm install` in the step above as this masks that install. Without that install
79+
there is nothing to mask.
7880

7981
```
8082
module.exports = {
@@ -98,3 +100,20 @@ module.exports = {
98100
npm ci
99101
npm start dev
100102
```
103+
104+
# Local Development for the Backend Plugin w/Tutor
105+
106+
```
107+
# The first time, after that you don't need to do this
108+
tutor mounts add lms:/home/feanil/src/hacking/sample-plugin/backend:/openedx/sample-plugin-backend
109+
tutor dev launch
110+
111+
# Every time
112+
tutor dev start
113+
tutor dev exec lms bash
114+
# inside the lms bash shell
115+
pip install -e ../sample-plugin-backend
116+
python manage.py lms migrate
117+
# exit the lms bash shell
118+
tutor dev restart lms
119+
```

backend/codecov.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,4 +9,4 @@ coverage:
99
enabled: yes
1010
target: 100%
1111

12-
comment: false
12+
comment: true

backend/tox.ini

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
[tox]
2-
envlist = py312-django{42},docs,quality,pii_check
2+
envlist = py{311,312}-django{42,52},docs,quality,pii_check
33

44
[doc8]
55
; D001 = Line too long
@@ -37,10 +37,11 @@ norecursedirs = .* docs requirements site-packages
3737
[testenv]
3838
deps =
3939
django42: Django>=4.0,<5.0
40+
django52: Django>=5.0,<6.0
4041
-r{toxinidir}/requirements/test.txt
4142
commands =
42-
python manage.py check
4343
pytest {posargs}
44+
python manage.py check
4445

4546
[testenv:docs]
4647
setenv =

0 commit comments

Comments
 (0)