From 501b3fdba73573bc7652fa15f66017ce874d1970 Mon Sep 17 00:00:00 2001 From: Abdullah Qureshi <111448185+arbimaq@users.noreply.github.com> Date: Mon, 16 Sep 2024 15:31:05 +0500 Subject: [PATCH 1/2] chore: migrate to resourceloader --- .github/workflows/ci.yml | 2 +- .github/workflows/pypi-publish.yml | 2 +- qualtricssurvey/mixins/scenario.py | 58 ++++-------------------------- requirements/base.txt | 28 +++++++-------- requirements/ci.txt | 35 ++++++++---------- requirements/pip.txt | 8 ++--- requirements/pip_tools.txt | 21 ++++------- requirements/quality.txt | 58 +++++++++++++++--------------- requirements/test.txt | 16 +++++---- requirements/tox.txt | 22 +++++------- setup.py | 3 +- tox.ini | 2 +- 12 files changed, 94 insertions(+), 161 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 9e6c687..026928a 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,7 +14,7 @@ jobs: strategy: matrix: os: [ubuntu-20.04] - python-version: ['3.8'] + python-version: ['3.11'] toxenv: [django32, django42, quality, csslint, eslint] steps: diff --git a/.github/workflows/pypi-publish.yml b/.github/workflows/pypi-publish.yml index a8e10c3..142b77d 100644 --- a/.github/workflows/pypi-publish.yml +++ b/.github/workflows/pypi-publish.yml @@ -15,7 +15,7 @@ jobs: - name: setup python uses: actions/setup-python@v3 with: - python-version: 3.8 + python-version: 3.11 - name: Install pip run: pip install -r requirements/pip.txt diff --git a/qualtricssurvey/mixins/scenario.py b/qualtricssurvey/mixins/scenario.py index 35f5b79..3b20c7b 100644 --- a/qualtricssurvey/mixins/scenario.py +++ b/qualtricssurvey/mixins/scenario.py @@ -1,55 +1,14 @@ """ Mixin workbench behavior into XBlocks """ -from glob import glob -import pkg_resources - -def _read_file(file_path): - """ - Read in a file's contents - """ - with open(file_path, encoding='utf-8') as file_input: - file_contents = file_input.read() - return file_contents - - -def _parse_title(file_path): - """ - Parse a title from a file name - """ - title = file_path - title = title.split('/')[-1] - title = '.'.join(title.split('.')[:-1]) - title = ' '.join(title.split('-')) - title = ' '.join([ - word.capitalize() - for word in title.split(' ') - ]) - return title +try: + from xblock.utils.resources import ResourceLoader +except ModuleNotFoundError: + from xblockutils.resources import ResourceLoader -def _read_files(files): - """ - Read the contents of a list of files - """ - file_contents = [ - ( - _parse_title(file_path), - _read_file(file_path), - ) - for file_path in files - ] - return file_contents - - -def _find_files(directory): - """ - Find XML files in the directory - """ - pattern = f"{directory}/*.xml" - files = glob(pattern) - return files +loader = ResourceLoader(__name__) class XBlockWorkbenchMixin: @@ -62,9 +21,4 @@ def workbench_scenarios(cls): """ Gather scenarios to be displayed in the workbench """ - module = cls.__module__ - module = module.split('.', maxsplit=1)[0] - directory = pkg_resources.resource_filename(module, 'scenarios') - files = _find_files(directory) - scenarios = _read_files(files) - return scenarios + return loader.load_scenarios_from_path("../scenarios") diff --git a/requirements/base.txt b/requirements/base.txt index 3c1958d..1b178fc 100644 --- a/requirements/base.txt +++ b/requirements/base.txt @@ -1,50 +1,48 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # appdirs==1.4.4 # via fs -asgiref==3.7.2 +asgiref==3.8.1 # via django -django==3.2.24 +django==3.2.25 # via # -c requirements/common_constraints.txt # -r requirements/base.in fs==2.4.16 # via xblock -lxml==5.1.0 +lxml==5.3.0 # via xblock -mako==1.3.2 +mako==1.3.5 # via xblock markupsafe==2.1.5 # via # mako # xblock -python-dateutil==2.8.2 +python-dateutil==2.9.0.post0 # via xblock -pytz==2024.1 +pytz==2024.2 # via # django # xblock -pyyaml==6.0.1 +pyyaml==6.0.2 # via xblock -simplejson==3.19.2 +simplejson==3.19.3 # via xblock six==1.16.0 # via # fs # python-dateutil -sqlparse==0.4.4 +sqlparse==0.5.1 # via django -typing-extensions==4.10.0 - # via asgiref -web-fragments==2.1.0 +web-fragments==2.2.0 # via xblock -webob==1.8.7 +webob==1.8.8 # via xblock -xblock==1.10.0 +xblock==5.1.0 # via -r requirements/base.in # The following packages are considered to be unsafe in a requirements file: diff --git a/requirements/ci.txt b/requirements/ci.txt index 4987c48..f65d521 100644 --- a/requirements/ci.txt +++ b/requirements/ci.txt @@ -1,14 +1,14 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # -cachetools==5.3.2 +cachetools==5.5.0 # via # -r requirements/tox.txt # tox -certifi==2024.2.2 +certifi==2024.8.30 # via requests chardet==5.2.0 # via @@ -20,9 +20,9 @@ colorama==0.4.6 # via # -r requirements/tox.txt # tox -coverage==6.5.0 +coverage[toml]==7.6.1 # via coveralls -coveralls==3.3.1 +coveralls==4.0.1 # via -r requirements/ci.in distlib==0.3.8 # via @@ -30,43 +30,38 @@ distlib==0.3.8 # virtualenv docopt==0.6.2 # via coveralls -filelock==3.13.1 +filelock==3.16.0 # via # -r requirements/tox.txt # tox # virtualenv -idna==3.6 +idna==3.10 # via requests -packaging==23.2 +packaging==24.1 # via # -r requirements/tox.txt # pyproject-api # tox -platformdirs==4.2.0 +platformdirs==4.3.3 # via # -r requirements/tox.txt # tox # virtualenv -pluggy==1.4.0 +pluggy==1.5.0 # via # -r requirements/tox.txt # tox -pyproject-api==1.6.1 +pyproject-api==1.7.1 # via # -r requirements/tox.txt # tox -requests==2.31.0 +requests==2.32.3 # via coveralls -tomli==2.0.1 - # via - # -r requirements/tox.txt - # pyproject-api - # tox -tox==4.13.0 +tox==4.18.1 # via -r requirements/tox.txt -urllib3==2.2.1 +urllib3==2.2.3 # via requests -virtualenv==20.25.1 +virtualenv==20.26.4 # via # -r requirements/tox.txt # tox diff --git a/requirements/pip.txt b/requirements/pip.txt index 6665603..ec02f2b 100644 --- a/requirements/pip.txt +++ b/requirements/pip.txt @@ -1,14 +1,14 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # -wheel==0.42.0 +wheel==0.44.0 # via -r requirements/pip.in # The following packages are considered to be unsafe in a requirements file: -pip==24.0 +pip==24.2 # via -r requirements/pip.in -setuptools==69.1.1 +setuptools==75.0.0 # via -r requirements/pip.in diff --git a/requirements/pip_tools.txt b/requirements/pip_tools.txt index fb84d10..77d81ad 100644 --- a/requirements/pip_tools.txt +++ b/requirements/pip_tools.txt @@ -1,32 +1,23 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # -build==1.0.3 +build==1.2.2 # via pip-tools click==8.1.7 # via pip-tools -importlib-metadata==7.0.1 +packaging==24.1 # via build -packaging==23.2 - # via build -pip-tools==7.4.0 +pip-tools==7.4.1 # via -r requirements/pip_tools.in -pyproject-hooks==1.0.0 - # via - # build - # pip-tools -tomli==2.0.1 +pyproject-hooks==1.1.0 # via # build # pip-tools - # pyproject-hooks -wheel==0.42.0 +wheel==0.44.0 # via pip-tools -zipp==3.17.0 - # via importlib-metadata # The following packages are considered to be unsafe in a requirements file: # pip diff --git a/requirements/quality.txt b/requirements/quality.txt index ea520aa..4b304f0 100644 --- a/requirements/quality.txt +++ b/requirements/quality.txt @@ -1,5 +1,5 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade @@ -8,21 +8,25 @@ appdirs==1.4.4 # via # -r requirements/base.txt # fs -asgiref==3.7.2 +asgiref==3.8.1 # via # -r requirements/base.txt # django -astroid==3.1.0 +astroid==3.2.4 # via pylint -coverage==7.4.3 +coverage==7.6.1 # via -r requirements/test.txt dill==0.3.8 # via pylint -django==3.2.24 +django==3.2.25 # via # -c requirements/common_constraints.txt # -r requirements/base.txt -edx-opaque-keys==2.5.1 +dnspython==2.6.1 + # via + # -r requirements/test.txt + # pymongo +edx-opaque-keys==2.11.0 # via -r requirements/test.txt fs==2.4.16 # via @@ -30,11 +34,11 @@ fs==2.4.16 # xblock isort==5.13.2 # via pylint -lxml==5.1.0 +lxml==5.3.0 # via # -r requirements/base.txt # xblock -mako==1.3.2 +mako==1.3.5 # via # -r requirements/base.txt # xblock @@ -47,34 +51,34 @@ mccabe==0.7.0 # via pylint mock==5.1.0 # via -r requirements/test.txt -pbr==6.0.0 +pbr==6.1.0 # via # -r requirements/test.txt # stevedore -platformdirs==4.2.0 +platformdirs==4.3.3 # via pylint -pycodestyle==2.11.1 +pycodestyle==2.12.1 # via -r requirements/quality.in -pylint==3.1.0 +pylint==3.2.7 # via -r requirements/quality.in -pymongo==3.13.0 +pymongo==4.8.0 # via # -r requirements/test.txt # edx-opaque-keys -python-dateutil==2.8.2 +python-dateutil==2.9.0.post0 # via # -r requirements/base.txt # xblock -pytz==2024.1 +pytz==2024.2 # via # -r requirements/base.txt # django # xblock -pyyaml==6.0.1 +pyyaml==6.0.2 # via # -r requirements/base.txt # xblock -simplejson==3.19.2 +simplejson==3.19.3 # via # -r requirements/base.txt # xblock @@ -83,35 +87,29 @@ six==1.16.0 # -r requirements/base.txt # fs # python-dateutil -sqlparse==0.4.4 +sqlparse==0.5.1 # via # -r requirements/base.txt # django -stevedore==5.2.0 +stevedore==5.3.0 # via # -r requirements/test.txt # edx-opaque-keys -tomli==2.0.1 +tomlkit==0.13.2 # via pylint -tomlkit==0.12.3 - # via pylint -typing-extensions==4.10.0 +typing-extensions==4.12.2 # via - # -r requirements/base.txt # -r requirements/test.txt - # asgiref - # astroid # edx-opaque-keys - # pylint -web-fragments==2.1.0 +web-fragments==2.2.0 # via # -r requirements/base.txt # xblock -webob==1.8.7 +webob==1.8.8 # via # -r requirements/base.txt # xblock -xblock==1.10.0 +xblock==5.1.0 # via -r requirements/base.txt # The following packages are considered to be unsafe in a requirements file: diff --git a/requirements/test.txt b/requirements/test.txt index f75e76d..00a237d 100644 --- a/requirements/test.txt +++ b/requirements/test.txt @@ -1,20 +1,22 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # -coverage==7.4.3 +coverage==7.6.1 # via -r requirements/test.in -edx-opaque-keys==2.5.1 +dnspython==2.6.1 + # via pymongo +edx-opaque-keys==2.11.0 # via -r requirements/test.in mock==5.1.0 # via -r requirements/test.in -pbr==6.0.0 +pbr==6.1.0 # via stevedore -pymongo==3.13.0 +pymongo==4.8.0 # via edx-opaque-keys -stevedore==5.2.0 +stevedore==5.3.0 # via edx-opaque-keys -typing-extensions==4.10.0 +typing-extensions==4.12.2 # via edx-opaque-keys diff --git a/requirements/tox.txt b/requirements/tox.txt index 9a12d68..606ba12 100644 --- a/requirements/tox.txt +++ b/requirements/tox.txt @@ -1,10 +1,10 @@ # -# This file is autogenerated by pip-compile with Python 3.8 +# This file is autogenerated by pip-compile with Python 3.11 # by the following command: # # make upgrade # -cachetools==5.3.2 +cachetools==5.5.0 # via tox chardet==5.2.0 # via tox @@ -12,27 +12,23 @@ colorama==0.4.6 # via tox distlib==0.3.8 # via virtualenv -filelock==3.13.1 +filelock==3.16.0 # via # tox # virtualenv -packaging==23.2 +packaging==24.1 # via # pyproject-api # tox -platformdirs==4.2.0 +platformdirs==4.3.3 # via # tox # virtualenv -pluggy==1.4.0 +pluggy==1.5.0 # via tox -pyproject-api==1.6.1 +pyproject-api==1.7.1 # via tox -tomli==2.0.1 - # via - # pyproject-api - # tox -tox==4.13.0 +tox==4.18.1 # via -r requirements/tox.in -virtualenv==20.25.1 +virtualenv==20.26.4 # via tox diff --git a/setup.py b/setup.py index 54a1997..b8dc986 100644 --- a/setup.py +++ b/setup.py @@ -117,8 +117,7 @@ def is_requirement(line): 'Operating System :: OS Independent', 'Programming Language :: JavaScript', 'Programming Language :: Python', - 'Programming Language :: Python :: 3.5', - 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.11', 'Framework :: Django', 'Framework :: Django :: 3.2', 'Framework :: Django :: 4.2', diff --git a/tox.ini b/tox.ini index 21e64e9..c7f58f6 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = csslint,eslint,py38-django{32,42},quality +envlist = csslint,eslint,py311-django{32,42},quality [testenv] deps = From f4dd9186e9e873dca6f48b8128c4980a59e87b06 Mon Sep 17 00:00:00 2001 From: Abdullah Qureshi <111448185+arbimaq@users.noreply.github.com> Date: Tue, 17 Sep 2024 19:40:06 +0500 Subject: [PATCH 2/2] chore: add python 3.12 support --- .github/workflows/ci.yml | 2 +- setup.py | 3 ++- tox.ini | 2 +- 3 files changed, 4 insertions(+), 3 deletions(-) diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml index 026928a..45cbff0 100644 --- a/.github/workflows/ci.yml +++ b/.github/workflows/ci.yml @@ -14,7 +14,7 @@ jobs: strategy: matrix: os: [ubuntu-20.04] - python-version: ['3.11'] + python-version: ['3.11', '3.12'] toxenv: [django32, django42, quality, csslint, eslint] steps: diff --git a/setup.py b/setup.py index b8dc986..5f2583d 100644 --- a/setup.py +++ b/setup.py @@ -8,7 +8,7 @@ from setuptools import find_packages, setup -version = '1.4.1' +version = '2.0.0' description = __doc__.strip().split('\n')[0] this_directory = path.abspath(path.dirname(__file__)) with open(path.join(this_directory, 'README.rst')) as file_in: @@ -118,6 +118,7 @@ def is_requirement(line): 'Programming Language :: JavaScript', 'Programming Language :: Python', 'Programming Language :: Python :: 3.11', + 'Programming Language :: Python :: 3.12', 'Framework :: Django', 'Framework :: Django :: 3.2', 'Framework :: Django :: 4.2', diff --git a/tox.ini b/tox.ini index c7f58f6..2447dde 100644 --- a/tox.ini +++ b/tox.ini @@ -1,5 +1,5 @@ [tox] -envlist = csslint,eslint,py311-django{32,42},quality +envlist = csslint,eslint,py{311,312}-django{42},quality [testenv] deps =