Skip to content

feanil/add plugin hooks #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
feanil merged 7 commits into from
Apr 16, 2025
Merged

feanil/add plugin hooks #4

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
aaa1e27
feat: Update settings and make migrations.
feanil Apr 14, 2025
4482355
feat: Add bits needed to make a django app plugin.
feanil Apr 15, 2025
30f5426
build: Add the edx-django-extensions and django_extensions libraries.
feanil Apr 15, 2025
4d5bfaf
feat: Add the migration for the new model.
feanil Apr 15, 2025
c655fbc
style: Run `black` on the rest of the project.
feanil Apr 15, 2025
094f94a
build: Install local editable after installing requirements.
feanil Apr 15, 2025
57dd371
test: Run all the tests when you call `tox`
feanil Apr 15, 2025
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
4 changes: 4 additions & 0 deletions backend/.gitignore
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -63,3 +63,7 @@ docs/sample_plugin.*.rst
# Private requirements
requirements/private.in
requirements/private.txt

# Test cruft
default.db
pii_report
2 changes: 2 additions & 0 deletions backend/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -67,6 +67,8 @@ piptools: ## install pinned version of pip-compile and pip-sync

requirements: clean_tox piptools ## install development environment requirements
pip-sync -q requirements/dev.txt requirements/private.*
# So that the plugin entrypoints are installed and loaded correctly.
pip install -e .

test: clean ## run tests in the current virtualenv
pytest
Expand Down
38 changes: 38 additions & 0 deletions backend/requirements/dev.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ cachetools==5.5.2
# via
# -r requirements/ci.txt
# tox
cffi==1.17.1
# via
# -r requirements/quality.txt
# pynacl
chardet==5.2.0
# via
# -r requirements/ci.txt
Expand All @@ -32,6 +36,7 @@ click==8.1.8
# -r requirements/quality.txt
# click-log
# code-annotations
# edx-django-utils
# edx-lint
# pip-tools
click-log==0.4.0
Expand Down Expand Up @@ -64,17 +69,33 @@ django==4.2.20
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/quality.txt
# django-crum
# django-extensions
# django-filter
# django-waffle
# djangorestframework
# edx-django-utils
# edx-i18n-tools
django-crum==0.7.9
# via
# -r requirements/quality.txt
# edx-django-utils
django-extensions==4.1
# via -r requirements/quality.txt
django-filter==25.1
# via -r requirements/quality.txt
django-waffle==4.2.0
# via
# -r requirements/quality.txt
# edx-django-utils
djangorestframework==3.16.0
# via -r requirements/quality.txt
dnspython==2.7.0
# via
# -r requirements/quality.txt
# pymongo
edx-django-utils==7.4.0
# via -r requirements/quality.txt
edx-i18n-tools==1.7.0
# via -r requirements/dev.in
edx-lint==5.6.0
Expand Down Expand Up @@ -113,6 +134,10 @@ mccabe==0.7.0
# via
# -r requirements/quality.txt
# pylint
newrelic==10.9.0
# via
# -r requirements/quality.txt
# edx-django-utils
openedx-atlas==0.7.0
# via -r requirements/quality.txt
packaging==24.2
Expand Down Expand Up @@ -148,8 +173,16 @@ pluggy==1.5.0
# tox
polib==1.2.0
# via edx-i18n-tools
psutil==7.0.0
# via
# -r requirements/quality.txt
# edx-django-utils
pycodestyle==2.13.0
# via -r requirements/quality.txt
pycparser==2.22
# via
# -r requirements/quality.txt
# cffi
pydocstyle==6.3.0
# via -r requirements/quality.txt
pygments==2.19.1
Expand Down Expand Up @@ -178,6 +211,10 @@ pymongo==4.12.0
# via
# -r requirements/quality.txt
# edx-opaque-keys
pynacl==1.5.0
# via
# -r requirements/quality.txt
# edx-django-utils
pyproject-api==1.9.0
# via
# -r requirements/ci.txt
Expand Down Expand Up @@ -221,6 +258,7 @@ stevedore==5.4.1
# via
# -r requirements/quality.txt
# code-annotations
# edx-django-utils
# edx-opaque-keys
text-unidecode==1.3
# via
Expand Down
39 changes: 37 additions & 2 deletions backend/requirements/doc.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,13 +23,17 @@ build==1.2.2.post1
certifi==2025.1.31
# via requests
cffi==1.17.1
# via cryptography
# via
# -r requirements/test.txt
# cryptography
# pynacl
charset-normalizer==3.4.1
# via requests
click==8.1.8
# via
# -r requirements/test.txt
# code-annotations
# edx-django-utils
code-annotations==2.3.0
# via -r requirements/test.txt
coverage[toml]==7.8.0
Expand All @@ -42,10 +46,24 @@ django==4.2.20
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# django-crum
# django-extensions
# django-filter
# django-waffle
# djangorestframework
# edx-django-utils
django-crum==0.7.9
# via
# -r requirements/test.txt
# edx-django-utils
django-extensions==4.1
# via -r requirements/test.txt
django-filter==25.1
# via -r requirements/test.txt
django-waffle==4.2.0
# via
# -r requirements/test.txt
# edx-django-utils
djangorestframework==3.16.0
# via -r requirements/test.txt
dnspython==2.7.0
Expand All @@ -61,6 +79,8 @@ docutils==0.21.2
# readme-renderer
# restructuredtext-lint
# sphinx
edx-django-utils==7.4.0
# via -r requirements/test.txt
edx-opaque-keys==2.12.0
# via -r requirements/test.txt
id==1.5.0
Expand Down Expand Up @@ -102,6 +122,10 @@ more-itertools==10.6.0
# via
# jaraco-classes
# jaraco-functools
newrelic==10.9.0
# via
# -r requirements/test.txt
# edx-django-utils
nh3==0.2.21
# via readme-renderer
openedx-atlas==0.7.0
Expand All @@ -122,8 +146,14 @@ pluggy==1.5.0
# via
# -r requirements/test.txt
# pytest
psutil==7.0.0
# via
# -r requirements/test.txt
# edx-django-utils
pycparser==2.22
# via cffi
# via
# -r requirements/test.txt
# cffi
pydata-sphinx-theme==0.15.4
# via sphinx-book-theme
pygments==2.19.1
Expand All @@ -138,6 +168,10 @@ pymongo==4.12.0
# via
# -r requirements/test.txt
# edx-opaque-keys
pynacl==1.5.0
# via
# -r requirements/test.txt
# edx-django-utils
pyproject-hooks==1.2.0
# via build
pytest==8.3.5
Expand Down Expand Up @@ -209,6 +243,7 @@ stevedore==5.4.1
# -r requirements/test.txt
# code-annotations
# doc8
# edx-django-utils
# edx-opaque-keys
text-unidecode==1.3
# via
Expand Down
38 changes: 38 additions & 0 deletions backend/requirements/quality.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,11 +12,16 @@ astroid==3.3.9
# via
# pylint
# pylint-celery
cffi==1.17.1
# via
# -r requirements/test.txt
# pynacl
click==8.1.8
# via
# -r requirements/test.txt
# click-log
# code-annotations
# edx-django-utils
# edx-lint
click-log==0.4.0
# via edx-lint
Expand All @@ -34,16 +39,32 @@ django==4.2.20
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/test.txt
# django-crum
# django-extensions
# django-filter
# django-waffle
# djangorestframework
# edx-django-utils
django-crum==0.7.9
# via
# -r requirements/test.txt
# edx-django-utils
django-extensions==4.1
# via -r requirements/test.txt
django-filter==25.1
# via -r requirements/test.txt
django-waffle==4.2.0
# via
# -r requirements/test.txt
# edx-django-utils
djangorestframework==3.16.0
# via -r requirements/test.txt
dnspython==2.7.0
# via
# -r requirements/test.txt
# pymongo
edx-django-utils==7.4.0
# via -r requirements/test.txt
edx-lint==5.6.0
# via -r requirements/quality.in
edx-opaque-keys==2.12.0
Expand All @@ -66,6 +87,10 @@ markupsafe==3.0.2
# jinja2
mccabe==0.7.0
# via pylint
newrelic==10.9.0
# via
# -r requirements/test.txt
# edx-django-utils
openedx-atlas==0.7.0
# via -r requirements/test.txt
packaging==24.2
Expand All @@ -82,8 +107,16 @@ pluggy==1.5.0
# via
# -r requirements/test.txt
# pytest
psutil==7.0.0
# via
# -r requirements/test.txt
# edx-django-utils
pycodestyle==2.13.0
# via -r requirements/quality.in
pycparser==2.22
# via
# -r requirements/test.txt
# cffi
pydocstyle==6.3.0
# via -r requirements/quality.in
pylint==3.3.6
Expand All @@ -104,6 +137,10 @@ pymongo==4.12.0
# via
# -r requirements/test.txt
# edx-opaque-keys
pynacl==1.5.0
# via
# -r requirements/test.txt
# edx-django-utils
pytest==8.3.5
# via
# -r requirements/test.txt
Expand Down Expand Up @@ -133,6 +170,7 @@ stevedore==5.4.1
# via
# -r requirements/test.txt
# code-annotations
# edx-django-utils
# edx-opaque-keys
text-unidecode==1.3
# via
Expand Down
2 changes: 2 additions & 0 deletions backend/requirements/test.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,3 +6,5 @@
pytest-cov # pytest extension for code coverage statistics
pytest-django # pytest extension for better Django support
code-annotations # provides commands used by the pii_check make target.
edx-django-utils # Open edX Django utilities, needed for plugin testing
django_extensions # Helpful dev commans including 'show_urls'
27 changes: 26 additions & 1 deletion backend/requirements/test.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,25 +8,41 @@ asgiref==3.8.1
# via
# -r requirements/base.txt
# django
cffi==1.17.1
# via pynacl
click==8.1.8
# via code-annotations
# via
# code-annotations
# edx-django-utils
code-annotations==2.3.0
# via -r requirements/test.in
coverage[toml]==7.8.0
# via pytest-cov
# via
# -c https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt
# -r requirements/base.txt
# django-crum
# django-extensions
# django-filter
# django-waffle
# djangorestframework
# edx-django-utils
django-crum==0.7.9
# via edx-django-utils
django-extensions==4.1
# via -r requirements/test.in
django-filter==25.1
# via -r requirements/base.txt
django-waffle==4.2.0
# via edx-django-utils
djangorestframework==3.16.0
# via -r requirements/base.txt
dnspython==2.7.0
# via
# -r requirements/base.txt
# pymongo
edx-django-utils==7.4.0
# via -r requirements/test.in
edx-opaque-keys==2.12.0
# via -r requirements/base.txt
iniconfig==2.1.0
Expand All @@ -35,6 +51,8 @@ jinja2==3.1.6
# via code-annotations
markupsafe==3.0.2
# via jinja2
newrelic==10.9.0
# via edx-django-utils
openedx-atlas==0.7.0
# via -r requirements/base.txt
packaging==24.2
Expand All @@ -45,10 +63,16 @@ pbr==6.1.1
# stevedore
pluggy==1.5.0
# via pytest
psutil==7.0.0
# via edx-django-utils
pycparser==2.22
# via cffi
pymongo==4.12.0
# via
# -r requirements/base.txt
# edx-opaque-keys
pynacl==1.5.0
# via edx-django-utils
pytest==8.3.5
# via
# pytest-cov
Expand All @@ -69,6 +93,7 @@ stevedore==5.4.1
# via
# -r requirements/base.txt
# code-annotations
# edx-django-utils
# edx-opaque-keys
text-unidecode==1.3
# via python-slugify
Expand Down
Loading