All notable changes to this project will be documented in this file.
The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.
Please do not update the unreleased notes.
v10.6.0 - (2024-09-17)
- Integration Tests: A new set of integration tests was added to validate the Users API. These tests ensure the correct behavior of endpoints interacting with Open edX components.
- Unit Tests: The unit tests were moved to a new directory,
/unit
, to separate them from the integration tests. This change aims to improve the organization of the tests and make it easier to identify the different types of tests.
v10.5.1 - (2024-07-19)
- Redwood Compatibility: Corrected a build-time error, ensuring full
compatibility with the Redwood release. For this, a new
ImproperlyConfigured
exception is handled when loading the API permissions.
- Improve Documentation: Update the README to include a more detailed description of the project and its features. A new how-to section was included with information about API, Middlewares, and pipelines.
v10.5.0 - (2024-07-08)
- Integration Tests: A new GitHub workflow has been added to run
integration tests. These tests validate backend imports and ensure
the
/eox-info
endpoint functions correctly.
- Redwood Support: Upgrade requirements base on edx-platform Redwood release, update GitHub workflows with new actions version, and update integration test to use new Redwood release with Tutor.
v10.4.0 - 2024-05-24
10.4.0 (2024-05-24)
v10.3.0 - 2024-05-23
10.3.0 (2024-05-23)
v10.2.0 - 2024-05-17
10.2.0 (2024-05-17)
v10.1.0 - 2024-03-19
10.1.0 (2024-03-19)
v10.0.0 - 2024-02-01
10.0.0 (2024-02-01)
-
add compatibility with quince release
-
chore: update constraints & upgrade requirements
-
fix: was mandatory to send any get_response
-
chore: update github-actions
-
chore: install test dependencies as dev ones
-
docs: update README for showing quince support
-
fix: malformed table
v9.1.1 - 2024-01-25
9.1.1 (2024-01-25)
v9.1.0 - 2024-01-12
9.1.0 (2024-01-12)
v9.0.0 - 2023-11-30
9.0.0 (2023-11-30)
-
remove openedx-events constraint to use what's installed (#252)
-
add compatibility with palm
-
ci: update workflow versions
-
chore: update constraints
-
chore: update requirements
-
fix: remove python 3.10 because it causes an error in the build created by backports-zoneinfo
-
fix: add and avoid to use general exceptions
-
fix: add timeout to the requests
-
fix: wrong import order
-
fix: improve pylint disables in code
-
docs: update the README.rst
-
fix: improve the exception to avoiding too general exception
-
chore: avoid being too restrictive in the constraint edx-opaque-keys
-
chore: update requirements
- remove all unused backends DS-703 (#257) (2b0c080)
- remove openedx-events constraint to use what's installed (#252) (8f3c550)
v8.2.0 - 2023-11-18
8.2.0 (2023-11-18)
- add string represantion to exc_value (#251) (1eacfb5), closes /github.com/eduNEXT/eox-core/blob/v6.1.0/eox_core/integrations/sentry.py#L154
v8.1.0 - 2023-03-20
8.1.0 (2023-03-20)
v8.0.0 - 2023-01-31
8.0.0 (2023-01-31)
- add compatibility with olive
v7.2.3 - 2023-01-12
7.2.3 (2023-01-12)
v7.2.2 - 2022-12-27
7.2.2 (2022-12-27)
- adds mantainer group (6532c3e)
v7.2.1 - 2022-12-21
7.2.1 (2022-12-21)
- ci: update bumpversion workflow to make changelog publish (935439c)
v7.2.0 - 2022-12-16
7.2.0 (2022-12-16)
- feat: add endpoint to create edxapp Oauth Application
v7.1.0 - 2022-12-16
7.1.0 (2022-12-16)
- feat: Make extra registration fields optional in during edxapp account creation
v7.0.1 - 2022-12-13
7.0.1 (2022-12-13)
- fix: update md4 to md5
v7.0.0 - 2022-10-07
7.0.0 (2022-10-07)
- drop django22 and added python 3.10
- feat: make it compatible with nutmeg
- perf: update requirements
- docs: update readme
- feat: drop django22 and added python 3.10
- ci: add python publish workflow and drop circleci
Co-authored-by: Maria Fernanda Magallanes Zubillaga [email protected] Co-authored-by: Juan David Buitrago [email protected]
- update CHANGELOG (1e20266)
v6.1.2 - 2022-10-04
6.1.2 (2022-10-04)
- remove try except and correct platform path (8a23616)
- update workflows commitlint and rm commitlint.config file (39c011c)
v6.1.1 - 2022-06-03
6.1.1 (2022-06-03)
- get settings course_org_filter when validating org for async proc (d4987ca)
v6.1.0 - 2022-05-25
6.1.0 (2022-05-25)
v6.0.2 - 2022-04-13
6.0.2 (2022-04-13)
v6.0.1 - 2022-03-07
6.0.1 (2022-03-07)
- replace create commit with create pr (#200) (b5e7336)
- ci: solve issue with bumpversion on github (320a698)
v6.0.0 - 2022-03-04
6.0.0 (2022-03-04)
- remove the Course Management feature
- django32: Drop python 3.5 support in favor of python 3.8.
- change extension of CHANGELOG file to markdown (effcef8)
- add bumpversion action to github workflows (#192) (99a4516)
- add changelog update job to bump_version workflow (6f758de)
- add commitlint action to github workflows (#194) (88da568)
- add conditional to run changelog update action (#195) (1595948)
- remove the Course Management feature (c0c3b55)
v5.1.1 - 2022-01-17
5.1.1 (2022-01-17)
- Add missing generate_password to the lilac users backend.
- Send post registration event during users registration through API.
- Upgrade sentry-sdk to latest release (backward compatible with previews python versions).
- Add missing backend for Third Party Auth.
- Separate eslint tests, so it doesn't block the PyPi release on CircleCi
- Use the Lilac backends for the test settings. Previous Open edX releases test
- suites may not be compatible.
- BREAKING CHANGE: Default backends for edxapp users, pre-enrollments and enrollments are not compatible with Juniper or older versions.
- Update Users backend for Lilac with Juniper backend.
- Openedx compatibility notes to readme.
- Date and time of enrolment creation to the Get CourseEnrollment endpoint.
- Avoid failure when getting first_name from OIDC user details.
- OIDC get_user_details method truncates user's first_name when exceeds max_length.
- Add new middleware to catch unhandled exceptions during the third party authentication.
- Add save_all_parameters argument to the eox-audit-model decorator for the Users API.
- Add filter_data list to the eox-audit-model decorator for the Enrollments API.
- Add force flag to post method of enrollments api
- Update serializers used by enrollments api
- Wrap course edxapp imports with try-except block.
- Course overview -edxapp model- function getter.
- Send post_register signal after user registration through API call.
- EdxappExtendedUserSerializer to include all the custom registration fields.
- New version of
edx-api-doc-tools
breaks Juniper, pin it to 1.4.0
- Add User API documentation.
- Allow profile fields to be included when creating a user.
- Add skip_password flag to omit password when creating a user if enabled.
- Allow user profile fields to be updated (update user endpoint).
- Allow searching by username when using the update user endpoint.
- Move audit_wrapper to audit-model and rename it.
- Record sensitive data as hidden fields (eg. passwords)
- Override the
get_user_id
method fromConfigurableOpenIdConnectAuth
to include a slug before the uid. - Add debug mode option to extra_data method from the ConfigurableOpenIdConnectAuth backend.
- Add extra_data to ConfigurableOpenIdConnectAuth.
- Update action names in EdxappPreEnrollment view.
- Add method override in ConfigurableOpenIdConnectAuth to avoid getting per class config.
- Decorate views that change or register some information.
- Include eox-audit-model wrapper.
- Add backends to fit lilac release.
- Add TPA pipeline steps to register signup sources.
- Add new endpoint to replace username.
- Add new endpoint to remove user.
- Add a new endoint to run celery taks
- Create a record in the UserAttribute table for each user with a password generated in the tpa pipeline.
- Add function that logs the information from the pipeline steps.
- Pipeline step force_user_post_save_callback now sends the post_save signal if the user is new.
- Add new pipeline step to ensure creation of users with usable password
- Integration tests for the Grades API.
- Integration tests now are only run if an environment variable
TEST_INTEGRATION
is set. - Fix the parsing of optional parameters for the Grades API.
- New Grades API to retrieve grades from a single user on a course.
- Pipeline function to assert information returned by the TPA provider.
- Pipeline function to avoid disconnection from TPA provider.
- Add swagger support.
- Improve internal documentation for the Enrollment API.
- New suite of Enrollment integration tests.
- BREAKING CHANGE: The requirements are not compatible with Ironwood anymore.
- Support for Ironwood.
- Revert previous change in order to add EoxCoreAPIPermission to UserInfo APIView.
- EoxCoreAPIPermission from UserInfo APIView
- Add support for django-filter versions superior to 2.0.0.
- Add support to enrollments API in Juniper.
- Add support for DOT clients in the EoxPermissions for API calls
- Change how dependencies are specified to comply with OEP-18.
- Juniper support.
- Add proctoring test settings since this had the wrong proctoring version.
- Adding bearer_authentication to support django-oauth2-provider and django-oauth-toolkit
- BREAKING CHANGE: Default backend for edxapp users now is not compatible with Ironwood. In order to use Ironwood, make sure that
- the Django setting EOX_CORE_USERS_BACKEND is equal to "eox_core.edxapp_wrapper.backends.users_h_v1".
- Ironwood support.
- LoginFailures andUserSignupsource admin models.
- Add a new configurable view to update edxapp users.
- First release on PyPI.
- Improve the way that we can filter sentry exceptions.
- Add a completely configurable OpenId Connect based backend for third party auth.
- Use USERNAME_MAX_LENGTH defined in edx-platform.
- Add capability to ignore exceptions in sentry.
- Adding sentry integration
- Remove microsite configuration mentions.
- Course management automation. This new Studio module allows you to make changes to the course configuration for several courses at once. More information: https://github.com/eduNEXT/eox-core#course-management-automation
- Linting tests: Now, pylint and eslint tests are running on CircleCI tests.