Merge branch 'master' into jenkins/zshkoor/setup-py-updated-280d88d

.github/workflows/ci.yml

@@ -14,13 +14,15 @@ jobs:
     runs-on: ${{ matrix.os }}
     strategy:
       matrix:
-        os: [ubuntu-20.04]
-        python-version: ['3.8']
-        toxenv: [quality, django32, django40]
+        os: [ubuntu-latest]
+        python-version:
+        - '3.11'
+        - '3.12'
+        toxenv: [quality, django42]
     steps:
     - uses: actions/checkout@v4
     - name: setup python
-      uses: actions/setup-python@v4
+      uses: actions/setup-python@v5
       with:
         python-version: ${{ matrix.python-version }}
 
@@ -36,8 +38,9 @@ jobs:
       run: make test
 
     - name: Run Coverage
-      if: matrix.python-version == '3.8' && matrix.toxenv=='django32'
-      uses: codecov/codecov-action@v3
+      if: matrix.python-version == '3.12' && matrix.toxenv=='django42'
+      uses: codecov/codecov-action@v4
       with:
+        token: ${{ secrets.CODECOV_TOKEN }}
         flags: unittests
         fail_ci_if_error: true

.github/workflows/publish_pypi.yml

@@ -8,15 +8,15 @@ on:
 jobs:
 
    push:
-     runs-on: ubuntu-20.04
+     runs-on: ubuntu-latest
 
      steps:
        - name: Checkout
          uses: actions/checkout@v4
        - name: setup python
-         uses: actions/setup-python@v4
+         uses: actions/setup-python@v5
          with:
-           python-version: 3.8
+           python-version: 3.11
 
        - name: Install pip
          run: pip install -r requirements/pip.txt

.github/workflows/upgrade-python-requirements.yml

@@ -13,8 +13,6 @@ jobs:
    call-upgrade-python-requirements-workflow:
     with:
        branch: ${{ github.event.inputs.branch }}
-       team_reviewers: "arbi-bom"
-       email_address: [email protected]  
        send_success_notification: false
     secrets:
        requirements_bot_github_token: ${{ secrets.REQUIREMENTS_BOT_GITHUB_TOKEN }}

CHANGELOG.rst

@@ -17,6 +17,25 @@ Unreleased
 ----------
 * Nothing
 
+[6.0.0]
+-------
+* Breaking Change: The EdxRestApiClient` has been deprecated and removed in this release.
+
+* Breaking Change: Dropping Python 3.8 support
+
+* We no longer test with ubuntu 20.04 and test with whatever is the latest
+  ubuntu supplied by the ``ubuntu-latest`` github action.  Not actually a
+  breaking change but a change in expectations that we're noting here. We
+  believe there is no code tied to the OS version in this library.
+
+[5.7.1]
+--------
+chore: Update Requirements specifically to unpin the requests library
+
+[5.7.0]
+--------
+feat: Adding python 3.11 and 3.12 support. Dropped django32 support.
+
 [5.6.0]
 --------
 chore: Update Requirements

Makefile

@@ -17,23 +17,42 @@ requirements: ## install development environment requirements
 test:
 	tox
 
-# Define PIP_COMPILE_OPTS=-v to get more information during make upgrade.
-PIP_COMPILE = pip-compile --upgrade $(PIP_COMPILE_OPTS)
+piptools:
+	pip install -q -r requirements/pip-tools.txt
 
-upgrade: export CUSTOM_COMPILE_COMMAND=make upgrade
-upgrade: ## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
-	pip install -qr requirements/pip-tools.txt
+define COMMON_CONSTRAINTS_TEMP_COMMENT
+# This is a temporary solution to override the real common_constraints.txt\n# In edx-lint, until the pyjwt constraint in edx-lint has been removed.\n# See BOM-2721 for more details.\n# Below is the copied and edited version of common_constraints\n
+endef
+
+COMMON_CONSTRAINTS_TXT=requirements/common_constraints.txt
+.PHONY: $(COMMON_CONSTRAINTS_TXT)
+$(COMMON_CONSTRAINTS_TXT):
+	wget -O "$(@)" https://raw.githubusercontent.com/edx/edx-lint/master/edx_lint/files/common_constraints.txt || touch "$(@)"
+	echo "$(COMMON_CONSTRAINTS_TEMP_COMMENT)" | cat - $(@) > temp && mv temp $(@)
+
+
+export CUSTOM_COMPILE_COMMAND = make upgrade
+compile-requirements: piptools $(COMMON_CONSTRAINTS_TXT)	## update the requirements/*.txt files with the latest packages satisfying requirements/*.in
 	# Make sure to compile files after any other files they include!
-	$(PIP_COMPILE) --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
-	$(PIP_COMPILE) -o requirements/pip-tools.txt requirements/pip-tools.in
+	sed '/^importlib-metadata</d' requirements/common_constraints.txt > requirements/common_constraints.tmp
+	mv requirements/common_constraints.tmp requirements/common_constraints.txt
+	pip-compile ${COMPILE_OPTS} --allow-unsafe --rebuild -o requirements/pip.txt requirements/pip.in
+	pip-compile ${COMPILE_OPTS} --allow-unsafe --verbose --rebuild -o requirements/pip-tools.txt requirements/pip-tools.in
 	pip install -qr requirements/pip.txt
 	pip install -qr requirements/pip-tools.txt
-	$(PIP_COMPILE) -o requirements/base.txt requirements/base.in
-	$(PIP_COMPILE) -o requirements/test.txt requirements/test.in
-	$(PIP_COMPILE) -o requirements/ci.txt requirements/ci.in
-	$(PIP_COMPILE) -o requirements/dev.txt requirements/dev.in
-	# Let tox control the Django version for tests
-	sed '/^[dD]jango==/d' requirements/test.txt > requirements/test.tmp
-	mv requirements/test.tmp requirements/test.txt
+	sed 's/Django<4.0//g' requirements/common_constraints.txt > requirements/common_constraints.tmp
+	mv requirements/common_constraints.tmp requirements/common_constraints.txt
+	pip-compile ${COMPILE_OPTS}  --allow-unsafe --verbose --rebuild -o requirements/base.txt requirements/base.in
+	pip-compile ${COMPILE_OPTS}  --allow-unsafe --verbose --rebuild -o requirements/test.txt requirements/test.in
+	pip-compile ${COMPILE_OPTS}  --allow-unsafe --verbose --rebuild -o requirements/dev.txt requirements/dev.in
+	pip-compile ${COMPILE_OPTS}  --allow-unsafe --verbose --rebuild -o requirements/pip-tools.txt requirements/pip-tools.in
+	pip-compile ${COMPILE_OPTS}  --allow-unsafe --verbose --rebuild -o requirements/ci.txt requirements/ci.in
+	# Let tox control the Django and DRF versions for tests
+	sed -i.tmp '/^django==/d' requirements/test.txt
+	sed -i.tmp '/^djangorestframework==/d' requirements/test.txt
+	rm requirements/test.txt.tmp
+
+upgrade:  ## update the pip requirements files to use the latest releases satisfying our constraints
+	$(MAKE) compile-requirements COMPILE_OPTS="--upgrade"
 
 validate: test quality

catalog-info.yaml

@@ -19,6 +19,6 @@ spec:
   # (Required) This can be a group (`group:<github_group_name>`) or a user (`user:<github_username>`).
   # Don't forget the "user:" or "group:" prefix. Groups must be GitHub team
   # names in the openedx GitHub organization: https://github.com/orgs/openedx/teams
-  owner: group:arch-bom
+  owner: "group:openedx-unmaintained"
   type: 'library'
   lifecycle: 'production'

edx_rest_api_client/__version__.py

@@ -1 +1 @@
-__version__ = '5.6.0'
+__version__ = '6.0.0'

edx_rest_api_client/client.py

@@ -1,17 +1,16 @@
 import datetime
 import json
-import os
 import socket
+import os
 
 import crum
 import requests
 import requests.utils
-import slumber
 from edx_django_utils.cache import TieredCache
 from edx_django_utils.monitoring import set_custom_attribute
 
 from edx_rest_api_client.__version__ import __version__
-from edx_rest_api_client.auth import BearerAuth, JwtAuth, SuppliedJwtAuth
+from edx_rest_api_client.auth import SuppliedJwtAuth
 
 # When caching tokens, use this value to err on expiring tokens a little early so they are
 # sure to be valid at the time they are used.
@@ -299,69 +298,3 @@ def request(self, method, url, headers=None, **kwargs):  # pylint: disable=argum
         set_custom_attribute('api_client', 'OAuthAPIClient')
         self._ensure_authentication()
         return super().request(method, url, headers=headers, **kwargs)
-
-
-class EdxRestApiClient(slumber.API):
-    """
-    API client for edX REST API.
-
-    (deprecated)  See docs/decisions/0002-oauth-api-client-replacement.rst.
-    """
-
-    @classmethod
-    def user_agent(cls):
-        return USER_AGENT
-
-    @classmethod
-    def get_oauth_access_token(cls, url, client_id, client_secret, token_type='bearer',
-                               timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
-        #     'To help transition to OAuthAPIClient, use EdxRestApiClient.get_and_cache_jwt_oauth_access_token instead'
-        #     'of EdxRestApiClient.get_oauth_access_token to share cached jwt token used by OAuthAPIClient.'
-        return get_oauth_access_token(url, client_id, client_secret, token_type=token_type, timeout=timeout)
-
-    @classmethod
-    def get_and_cache_jwt_oauth_access_token(cls, url, client_id, client_secret,
-                                             timeout=(REQUEST_CONNECT_TIMEOUT, REQUEST_READ_TIMEOUT)):
-        return get_and_cache_oauth_access_token(url, client_id, client_secret, token_type="jwt", timeout=timeout)
-
-    def __init__(self, url, signing_key=None, username=None, full_name=None, email=None,
-                 timeout=5, issuer=None, expires_in=30, tracking_context=None, oauth_access_token=None,
-                 session=None, jwt=None, **kwargs):
-        """
-        EdxRestApiClient is deprecated. Use OAuthAPIClient instead.
-
-        Instantiate a new client. You can pass extra kwargs to Slumber like
-        'append_slash'.
-
-        Raises:
-            ValueError: If a URL is not provided.
-
-        """
-        set_custom_attribute('api_client', 'EdxRestApiClient')
-        if not url:
-            raise ValueError('An API url must be supplied!')
-
-        if jwt:
-            auth = SuppliedJwtAuth(jwt)
-        elif oauth_access_token:
-            auth = BearerAuth(oauth_access_token)
-        elif signing_key and username:
-            auth = JwtAuth(username, full_name, email, signing_key,
-                           issuer=issuer, expires_in=expires_in, tracking_context=tracking_context)
-        else:
-            auth = None
-
-        session = session or requests.Session()
-        session.headers['User-Agent'] = self.user_agent()
-
-        session.timeout = timeout
-        super().__init__(
-            url,
-            session=session,
-            auth=auth,
-            **kwargs
-        )
-
-
-EdxRestApiClient.user_agent.__func__.__doc__ = user_agent.__doc__
-EdxRestApiClient.get_oauth_access_token.__func__.__doc__ = get_oauth_access_token.__doc__

edx_rest_api_client/exceptions.py

@@ -1,3 +1,2 @@
 # noinspection PyUnresolvedReferences
 from requests.exceptions import Timeout  # pylint: disable=unused-import
-from slumber.exceptions import *  # pylint: disable=wildcard-import