remove hard-coded uid 1000

* feat: migrate from pylint/black to ruff

* test: verify python package distribution build when running make test

.editorconfig

@@ -1,17 +0,0 @@
-root = true
-
-[*]
-charset = utf-8
-end_of_line = lf
-indent_size = 4
-indent_style = space
-insert_final_newline = true
-max_line_length = 80
-trim_trailing_whitespace = true
-
-[*.md]
-max_line_length = 0
-trim_trailing_whitespace = false
-
-[COMMIT_EDITMSG]
-max_line_length = 0

.github/workflows/auto-add-to-project.yml

@@ -0,0 +1,20 @@
+name: Auto Add Issues and Pull Requests to Project
+
+on:
+  issues:
+    types:
+      - opened
+  pull_request_target:
+    types:
+      - opened
+
+jobs:
+  # https://github.com/actions/add-to-project
+  add-to-project:
+    name: Add issue and bugs to project
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/add-to-project@v1.0.2
+        with:
+          project-url: https://github.com/orgs/overhangio/projects/4
+          github-token: ${{ secrets.GH_PROJECT_PERSONAL_ACCESS_TOKEN }}

.github/workflows/sync.yml

@@ -2,13 +2,13 @@ name: Sync with private repo
 
 on:
   push:
-    branches: [ master, main, nightly ]
+    branches: [ release, main ]
 
 jobs:
   sync:
     runs-on: ubuntu-latest
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
         with:
           fetch-depth: 0
       - name: Add remote

.github/workflows/test.yml

@@ -0,0 +1,25 @@
+name: Run tests
+
+on:
+  pull_request:
+    branches: [ release, main ]
+  push:
+    branches: [ release, main ]
+
+jobs:
+  tests:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+         python-version: ['3.9', '3.12']
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version:  ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          pip install .[dev]
+      - name: Test lint, types, and format
+        run: make test

.gitlab-ci.yml

@@ -2,7 +2,6 @@ variables:
     TUTOR_PLUGIN: credentials
     TUTOR_IMAGES: credentials
     TUTOR_PYPI_PACKAGE: tutor-credentials
-    OPENEDX_RELEASE: palm
     GITHUB_REPO: overhangio/tutor-credentials
     TUTOR_EXTRA_ENABLED_PLUGINS: discovery mfe 
 

.hatch_build.py

@@ -0,0 +1,22 @@
+# https://hatch.pypa.io/latest/how-to/config/dynamic-metadata/
+import os
+import typing as t
+
+from hatchling.metadata.plugin.interface import MetadataHookInterface
+
+HERE = os.path.dirname(__file__)
+
+
+class MetaDataHook(MetadataHookInterface):
+    def update(self, metadata: dict[str, t.Any]) -> None:
+        about = load_about()
+        metadata["version"] = about["__version__"]
+
+
+def load_about() -> dict[str, str]:
+    about: dict[str, str] = {}
+    with open(
+        os.path.join(HERE, "tutorcredentials", "__about__.py"), "rt", encoding="utf-8"
+    ) as f:
+        exec(f.read(), about)
+    return about

.pre-commit-config.yaml

@@ -1,25 +0,0 @@
-default_language_version:
-  # default language version for each language
-  python: python3.8
-repos:
-  - repo: https://github.com/pre-commit/pre-commit-hooks
-    rev: v4.1.0
-    hooks:
-      # See https://pre-commit.com/hooks.html for more hooks
-      - id: check-added-large-files
-      - id: check-byte-order-marker
-      - id: check-case-conflict
-      - id: check-executables-have-shebangs
-      - id: check-json
-      - id: check-shebang-scripts-are-executable
-      - id: check-merge-conflict
-      - id: check-symlinks
-      - id: check-toml
-      - id: check-xml
-      - id: destroyed-symlinks
-      - id: detect-aws-credentials
-      - id: detect-private-key
-      - id: end-of-file-fixer
-      - id: trailing-whitespace
-      - id: pretty-format-json
-      - id: check-yaml

CHANGELOG.md

@@ -19,6 +19,61 @@ instructions, because git commits are used to generate release notes:
 
 <!-- scriv-insert-here -->
 
+<a id='changelog-20.0.0'></a>
+## v20.0.0 (2025-06-05)
+
+- [Improvement] Migrate packaging from setup.py/setuptools to pyproject.toml/hatch. (by @mlabeeb03)
+  - For more details view tutor core PR: https://github.com/overhangio/tutor/pull/1163
+
+- [Improvement] Add hatch_build.py in sdist target to fix the installation issues (by @dawoudsheraz)
+
+- 💥[Feature] Upgrade to Teak. (by @mlabeeb03)
+
+<a id='changelog-19.0.0'></a>
+## v19.0.0 (2024-10-23)
+
+- 💥 [Deprecation] Drop support for python 3.8 and set Python 3.9 as the minimum supported python version. (by @Faraz32123)
+- 💥[Improvement] Rename Tutor's two branches (by @DawoudSheraz):
+  * Rename **master** to **release**, as this branch runs the latest official Open edX release tag.
+  * Rename **nightly** to **main**, as this branch runs the Open edX master branches, which are the basis for the next Open edX release.
+- 💥[Feature] Upgrade to Sumac. (by @Faraz32123)
+- [BugFix] Uwsgi workers wasn't starting properly using `UWSGI_WORKERS` flag, passing the value directly fixes the issue. (by @Faraz32123)
+- 💥[Feature] Update Credentials Image to use Ubuntu `24.04` as base OS. (by @Faraz32123)
+  - Add `mime-support` alternatives that are `media-types mailcap`.
+  - Update `python-openssl` to `python3-openssl`.
+- [Bugfix] Fix legacy warnings during Docker build. (by @regisb)
+
+
+<a id='changelog-18.0.0'></a>
+## v18.0.0 (2024-06-07)
+
+- 💥[Feature] Upgrade to Redwood. (by @Faraz32123)
+- [Feature] Add `atlas pull` at build-time. (by @omarithawi)
+- [Bugfix] Make plugin compatible with Python 3.12 by removing dependency on `pkg_resources`. (by @regisb)
+- [Feature] Make it possible to use mounts for a local development. (by @cmltawt0)
+- [BugFix] Fix award program certificates error. (by @rohan-saeed)
+- 💥[Feature] Upgrade Python version to 3.11.9. (by @Faraz32123)
+- [BugFix] Fix custom image pull/push. (by @dyudyunov)
+
+<a id='changelog-17.0.1'></a>
+## v17.0.1 (2024-01-23)
+
+- [Bugfix] Fix initialization tasks in production. (by @Danyal-Faheem)
+
+<a id='changelog-17.0.0'></a>
+## v17.0.0 (2023-12-09)
+
+- 💥[Feature] Upgrade to Quince. (by @ Talha-Rizwan)
+- [Feature] Add support for the Learner Record MFE. (by @arbrandes)
+
+<a id='changelog-16.1.0'></a>
+## v16.1.0 (2023-11-30)
+
+- [Improvement] Added Typing to code, Makefile and test action to the repository and formatted code with Black and isort. (by @CodeWithEmad)
+- [Bugfix] Fix build error due to outdated nodeenv. (by @regisb)
+- [Bugfix] Added missing default configs that were missed during merge. (by @Faraz32123)
+- 💥[Improvement] Simplify plugin settings. As a consequence, many marketing settings are deprecated. If they were useful to you, you can override them using the "credentials-settings-common" patch. (by @regisb)
+
 <a id='changelog-16.0.3'></a>
 ## v16.0.3 (2023-11-21)
 

LICENSE.txt

@@ -0,0 +1,661 @@
+                    GNU AFFERO GENERAL PUBLIC LICENSE
+                       Version 3, 19 November 2007
+
+ Copyright (C) 2007 Free Software Foundation, Inc. <https://fsf.org/>
+ Everyone is permitted to copy and distribute verbatim copies
+ of this license document, but changing it is not allowed.
+
+                            Preamble
+
+  The GNU Affero General Public License is a free, copyleft license for
+software and other kinds of works, specifically designed to ensure
+cooperation with the community in the case of network server software.
+
+  The licenses for most software and other practical works are designed
+to take away your freedom to share and change the works.  By contrast,
+our General Public Licenses are intended to guarantee your freedom to
+share and change all versions of a program--to make sure it remains free
+software for all its users.
+
+  When we speak of free software, we are referring to freedom, not
+price.  Our General Public Licenses are designed to make sure that you
+have the freedom to distribute copies of free software (and charge for
+them if you wish), that you receive source code or can get it if you
+want it, that you can change the software or use pieces of it in new
+free programs, and that you know you can do these things.
+
+  Developers that use our General Public Licenses protect your rights
+with two steps: (1) assert copyright on the software, and (2) offer
+you this License which gives you legal permission to copy, distribute
+and/or modify the software.
+
+  A secondary benefit of defending all users' freedom is that
+improvements made in alternate versions of the program, if they
+receive widespread use, become available for other developers to
+incorporate.  Many developers of free software are heartened and
+encouraged by the resulting cooperation.  However, in the case of
+software used on network servers, this result may fail to come about.
+The GNU General Public License permits making a modified version and
+letting the public access it on a server without ever releasing its
+source code to the public.
+
+  The GNU Affero General Public License is designed specifically to
+ensure that, in such cases, the modified source code becomes available
+to the community.  It requires the operator of a network server to
+provide the source code of the modified version running there to the
+users of that server.  Therefore, public use of a modified version, on
+a publicly accessible server, gives the public access to the source
+code of the modified version.
+
+  An older license, called the Affero General Public License and
+published by Affero, was designed to accomplish similar goals.  This is
+a different license, not a version of the Affero GPL, but Affero has
+released a new version of the Affero GPL which permits relicensing under
+this license.
+
+  The precise terms and conditions for copying, distribution and
+modification follow.
+
+                       TERMS AND CONDITIONS
+
+  0. Definitions.
+
+  "This License" refers to version 3 of the GNU Affero General Public License.
+
+  "Copyright" also means copyright-like laws that apply to other kinds of
+works, such as semiconductor masks.
+
+  "The Program" refers to any copyrightable work licensed under this
+License.  Each licensee is addressed as "you".  "Licensees" and
+"recipients" may be individuals or organizations.
+
+  To "modify" a work means to copy from or adapt all or part of the work
+in a fashion requiring copyright permission, other than the making of an
+exact copy.  The resulting work is called a "modified version" of the
+earlier work or a work "based on" the earlier work.
+
+  A "covered work" means either the unmodified Program or a work based
+on the Program.
+
+  To "propagate" a work means to do anything with it that, without
+permission, would make you directly or secondarily liable for
+infringement under applicable copyright law, except executing it on a
+computer or modifying a private copy.  Propagation includes copying,
+distribution (with or without modification), making available to the
+public, and in some countries other activities as well.
+
+  To "convey" a work means any kind of propagation that enables other
+parties to make or receive copies.  Mere interaction with a user through
+a computer network, with no transfer of a copy, is not conveying.
+
+  An interactive user interface displays "Appropriate Legal Notices"
+to the extent that it includes a convenient and prominently visible
+feature that (1) displays an appropriate copyright notice, and (2)
+tells the user that there is no warranty for the work (except to the
+extent that warranties are provided), that licensees may convey the
+work under this License, and how to view a copy of this License.  If
+the interface presents a list of user commands or options, such as a
+menu, a prominent item in the list meets this criterion.
+
+  1. Source Code.
+
+  The "source code" for a work means the preferred form of the work
+for making modifications to it.  "Object code" means any non-source
+form of a work.
+
+  A "Standard Interface" means an interface that either is an official
+standard defined by a recognized standards body, or, in the case of
+interfaces specified for a particular programming language, one that
+is widely used among developers working in that language.
+
+  The "System Libraries" of an executable work include anything, other
+than the work as a whole, that (a) is included in the normal form of
+packaging a Major Component, but which is not part of that Major
+Component, and (b) serves only to enable use of the work with that
+Major Component, or to implement a Standard Interface for which an
+implementation is available to the public in source code form.  A
+"Major Component", in this context, means a major essential component
+(kernel, window system, and so on) of the specific operating system
+(if any) on which the executable work runs, or a compiler used to
+produce the work, or an object code interpreter used to run it.
+
+  The "Corresponding Source" for a work in object code form means all
+the source code needed to generate, install, and (for an executable
+work) run the object code and to modify the work, including scripts to
+control those activities.  However, it does not include the work's
+System Libraries, or general-purpose tools or generally available free
+programs which are used unmodified in performing those activities but
+which are not part of the work.  For example, Corresponding Source
+includes interface definition files associated with source files for
+the work, and the source code for shared libraries and dynamically
+linked subprograms that the work is specifically designed to require,
+such as by intimate data communication or control flow between those
+subprograms and other parts of the work.
+
+  The Corresponding Source need not include anything that users
+can regenerate automatically from other parts of the Corresponding
+Source.
+
+  The Corresponding Source for a work in source code form is that
+same work.
+
+  2. Basic Permissions.
+
+  All rights granted under this License are granted for the term of
+copyright on the Program, and are irrevocable provided the stated
+conditions are met.  This License explicitly affirms your unlimited
+permission to run the unmodified Program.  The output from running a
+covered work is covered by this License only if the output, given its
+content, constitutes a covered work.  This License acknowledges your
+rights of fair use or other equivalent, as provided by copyright law.
+
+  You may make, run and propagate covered works that you do not
+convey, without conditions so long as your license otherwise remains
+in force.  You may convey covered works to others for the sole purpose
+of having them make modifications exclusively for you, or provide you
+with facilities for running those works, provided that you comply with
+the terms of this License in conveying all material for which you do
+not control copyright.  Those thus making or running the covered works
+for you must do so exclusively on your behalf, under your direction
+and control, on terms that prohibit them from making any copies of
+your copyrighted material outside their relationship with you.
+
+  Conveying under any other circumstances is permitted solely under
+the conditions stated below.  Sublicensing is not allowed; section 10
+makes it unnecessary.
+
+  3. Protecting Users' Legal Rights From Anti-Circumvention Law.
+
+  No covered work shall be deemed part of an effective technological
+measure under any applicable law fulfilling obligations under article
+11 of the WIPO copyright treaty adopted on 20 December 1996, or
+similar laws prohibiting or restricting circumvention of such
+measures.
+
+  When you convey a covered work, you waive any legal power to forbid
+circumvention of technological measures to the extent such circumvention
+is effected by exercising rights under this License with respect to
+the covered work, and you disclaim any intention to limit operation or
+modification of the work as a means of enforcing, against the work's
+users, your or third parties' legal rights to forbid circumvention of
+technological measures.
+
+  4. Conveying Verbatim Copies.
+
+  You may convey verbatim copies of the Program's source code as you
+receive it, in any medium, provided that you conspicuously and
+appropriately publish on each copy an appropriate copyright notice;
+keep intact all notices stating that this License and any
+non-permissive terms added in accord with section 7 apply to the code;
+keep intact all notices of the absence of any warranty; and give all
+recipients a copy of this License along with the Program.
+
+  You may charge any price or no price for each copy that you convey,
+and you may offer support or warranty protection for a fee.
+
+  5. Conveying Modified Source Versions.
+
+  You may convey a work based on the Program, or the modifications to
+produce it from the Program, in the form of source code under the
+terms of section 4, provided that you also meet all of these conditions:
+
+    a) The work must carry prominent notices stating that you modified
+    it, and giving a relevant date.
+
+    b) The work must carry prominent notices stating that it is
+    released under this License and any conditions added under section
+    7.  This requirement modifies the requirement in section 4 to
+    "keep intact all notices".
+
+    c) You must license the entire work, as a whole, under this
+    License to anyone who comes into possession of a copy.  This
+    License will therefore apply, along with any applicable section 7
+    additional terms, to the whole of the work, and all its parts,
+    regardless of how they are packaged.  This License gives no
+    permission to license the work in any other way, but it does not
+    invalidate such permission if you have separately received it.
+
+    d) If the work has interactive user interfaces, each must display
+    Appropriate Legal Notices; however, if the Program has interactive
+    interfaces that do not display Appropriate Legal Notices, your
+    work need not make them do so.
+
+  A compilation of a covered work with other separate and independent
+works, which are not by their nature extensions of the covered work,
+and which are not combined with it such as to form a larger program,
+in or on a volume of a storage or distribution medium, is called an
+"aggregate" if the compilation and its resulting copyright are not
+used to limit the access or legal rights of the compilation's users
+beyond what the individual works permit.  Inclusion of a covered work
+in an aggregate does not cause this License to apply to the other
+parts of the aggregate.
+
+  6. Conveying Non-Source Forms.
+
+  You may convey a covered work in object code form under the terms
+of sections 4 and 5, provided that you also convey the
+machine-readable Corresponding Source under the terms of this License,
+in one of these ways:
+
+    a) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by the
+    Corresponding Source fixed on a durable physical medium
+    customarily used for software interchange.
+
+    b) Convey the object code in, or embodied in, a physical product
+    (including a physical distribution medium), accompanied by a
+    written offer, valid for at least three years and valid for as
+    long as you offer spare parts or customer support for that product
+    model, to give anyone who possesses the object code either (1) a
+    copy of the Corresponding Source for all the software in the
+    product that is covered by this License, on a durable physical
+    medium customarily used for software interchange, for a price no
+    more than your reasonable cost of physically performing this
+    conveying of source, or (2) access to copy the
+    Corresponding Source from a network server at no charge.
+
+    c) Convey individual copies of the object code with a copy of the
+    written offer to provide the Corresponding Source.  This
+    alternative is allowed only occasionally and noncommercially, and
+    only if you received the object code with such an offer, in accord
+    with subsection 6b.
+
+    d) Convey the object code by offering access from a designated
+    place (gratis or for a charge), and offer equivalent access to the
+    Corresponding Source in the same way through the same place at no
+    further charge.  You need not require recipients to copy the
+    Corresponding Source along with the object code.  If the place to
+    copy the object code is a network server, the Corresponding Source
+    may be on a different server (operated by you or a third party)
+    that supports equivalent copying facilities, provided you maintain
+    clear directions next to the object code saying where to find the
+    Corresponding Source.  Regardless of what server hosts the
+    Corresponding Source, you remain obligated to ensure that it is
+    available for as long as needed to satisfy these requirements.
+
+    e) Convey the object code using peer-to-peer transmission, provided
+    you inform other peers where the object code and Corresponding
+    Source of the work are being offered to the general public at no
+    charge under subsection 6d.
+
+  A separable portion of the object code, whose source code is excluded
+from the Corresponding Source as a System Library, need not be
+included in conveying the object code work.
+
+  A "User Product" is either (1) a "consumer product", which means any
+tangible personal property which is normally used for personal, family,
+or household purposes, or (2) anything designed or sold for incorporation
+into a dwelling.  In determining whether a product is a consumer product,
+doubtful cases shall be resolved in favor of coverage.  For a particular
+product received by a particular user, "normally used" refers to a
+typical or common use of that class of product, regardless of the status
+of the particular user or of the way in which the particular user
+actually uses, or expects or is expected to use, the product.  A product
+is a consumer product regardless of whether the product has substantial
+commercial, industrial or non-consumer uses, unless such uses represent
+the only significant mode of use of the product.
+
+  "Installation Information" for a User Product means any methods,
+procedures, authorization keys, or other information required to install
+and execute modified versions of a covered work in that User Product from
+a modified version of its Corresponding Source.  The information must
+suffice to ensure that the continued functioning of the modified object
+code is in no case prevented or interfered with solely because
+modification has been made.
+
+  If you convey an object code work under this section in, or with, or
+specifically for use in, a User Product, and the conveying occurs as
+part of a transaction in which the right of possession and use of the
+User Product is transferred to the recipient in perpetuity or for a
+fixed term (regardless of how the transaction is characterized), the
+Corresponding Source conveyed under this section must be accompanied
+by the Installation Information.  But this requirement does not apply
+if neither you nor any third party retains the ability to install
+modified object code on the User Product (for example, the work has
+been installed in ROM).
+
+  The requirement to provide Installation Information does not include a
+requirement to continue to provide support service, warranty, or updates
+for a work that has been modified or installed by the recipient, or for
+the User Product in which it has been modified or installed.  Access to a
+network may be denied when the modification itself materially and
+adversely affects the operation of the network or violates the rules and
+protocols for communication across the network.
+
+  Corresponding Source conveyed, and Installation Information provided,
+in accord with this section must be in a format that is publicly
+documented (and with an implementation available to the public in
+source code form), and must require no special password or key for
+unpacking, reading or copying.
+
+  7. Additional Terms.
+
+  "Additional permissions" are terms that supplement the terms of this
+License by making exceptions from one or more of its conditions.
+Additional permissions that are applicable to the entire Program shall
+be treated as though they were included in this License, to the extent
+that they are valid under applicable law.  If additional permissions
+apply only to part of the Program, that part may be used separately
+under those permissions, but the entire Program remains governed by
+this License without regard to the additional permissions.
+
+  When you convey a copy of a covered work, you may at your option
+remove any additional permissions from that copy, or from any part of
+it.  (Additional permissions may be written to require their own
+removal in certain cases when you modify the work.)  You may place
+additional permissions on material, added by you to a covered work,
+for which you have or can give appropriate copyright permission.
+
+  Notwithstanding any other provision of this License, for material you
+add to a covered work, you may (if authorized by the copyright holders of
+that material) supplement the terms of this License with terms:
+
+    a) Disclaiming warranty or limiting liability differently from the
+    terms of sections 15 and 16 of this License; or
+
+    b) Requiring preservation of specified reasonable legal notices or
+    author attributions in that material or in the Appropriate Legal
+    Notices displayed by works containing it; or
+
+    c) Prohibiting misrepresentation of the origin of that material, or
+    requiring that modified versions of such material be marked in
+    reasonable ways as different from the original version; or
+
+    d) Limiting the use for publicity purposes of names of licensors or
+    authors of the material; or
+
+    e) Declining to grant rights under trademark law for use of some
+    trade names, trademarks, or service marks; or
+
+    f) Requiring indemnification of licensors and authors of that
+    material by anyone who conveys the material (or modified versions of
+    it) with contractual assumptions of liability to the recipient, for
+    any liability that these contractual assumptions directly impose on
+    those licensors and authors.
+
+  All other non-permissive additional terms are considered "further
+restrictions" within the meaning of section 10.  If the Program as you
+received it, or any part of it, contains a notice stating that it is
+governed by this License along with a term that is a further
+restriction, you may remove that term.  If a license document contains
+a further restriction but permits relicensing or conveying under this
+License, you may add to a covered work material governed by the terms
+of that license document, provided that the further restriction does
+not survive such relicensing or conveying.
+
+  If you add terms to a covered work in accord with this section, you
+must place, in the relevant source files, a statement of the
+additional terms that apply to those files, or a notice indicating
+where to find the applicable terms.
+
+  Additional terms, permissive or non-permissive, may be stated in the
+form of a separately written license, or stated as exceptions;
+the above requirements apply either way.
+
+  8. Termination.
+
+  You may not propagate or modify a covered work except as expressly
+provided under this License.  Any attempt otherwise to propagate or
+modify it is void, and will automatically terminate your rights under
+this License (including any patent licenses granted under the third
+paragraph of section 11).
+
+  However, if you cease all violation of this License, then your
+license from a particular copyright holder is reinstated (a)
+provisionally, unless and until the copyright holder explicitly and
+finally terminates your license, and (b) permanently, if the copyright
+holder fails to notify you of the violation by some reasonable means
+prior to 60 days after the cessation.
+
+  Moreover, your license from a particular copyright holder is
+reinstated permanently if the copyright holder notifies you of the
+violation by some reasonable means, this is the first time you have
+received notice of violation of this License (for any work) from that
+copyright holder, and you cure the violation prior to 30 days after
+your receipt of the notice.
+
+  Termination of your rights under this section does not terminate the
+licenses of parties who have received copies or rights from you under
+this License.  If your rights have been terminated and not permanently
+reinstated, you do not qualify to receive new licenses for the same
+material under section 10.
+
+  9. Acceptance Not Required for Having Copies.
+
+  You are not required to accept this License in order to receive or
+run a copy of the Program.  Ancillary propagation of a covered work
+occurring solely as a consequence of using peer-to-peer transmission
+to receive a copy likewise does not require acceptance.  However,
+nothing other than this License grants you permission to propagate or
+modify any covered work.  These actions infringe copyright if you do
+not accept this License.  Therefore, by modifying or propagating a
+covered work, you indicate your acceptance of this License to do so.
+
+  10. Automatic Licensing of Downstream Recipients.
+
+  Each time you convey a covered work, the recipient automatically
+receives a license from the original licensors, to run, modify and
+propagate that work, subject to this License.  You are not responsible
+for enforcing compliance by third parties with this License.
+
+  An "entity transaction" is a transaction transferring control of an
+organization, or substantially all assets of one, or subdividing an
+organization, or merging organizations.  If propagation of a covered
+work results from an entity transaction, each party to that
+transaction who receives a copy of the work also receives whatever
+licenses to the work the party's predecessor in interest had or could
+give under the previous paragraph, plus a right to possession of the
+Corresponding Source of the work from the predecessor in interest, if
+the predecessor has it or can get it with reasonable efforts.
+
+  You may not impose any further restrictions on the exercise of the
+rights granted or affirmed under this License.  For example, you may
+not impose a license fee, royalty, or other charge for exercise of
+rights granted under this License, and you may not initiate litigation
+(including a cross-claim or counterclaim in a lawsuit) alleging that
+any patent claim is infringed by making, using, selling, offering for
+sale, or importing the Program or any portion of it.
+
+  11. Patents.
+
+  A "contributor" is a copyright holder who authorizes use under this
+License of the Program or a work on which the Program is based.  The
+work thus licensed is called the contributor's "contributor version".
+
+  A contributor's "essential patent claims" are all patent claims
+owned or controlled by the contributor, whether already acquired or
+hereafter acquired, that would be infringed by some manner, permitted
+by this License, of making, using, or selling its contributor version,
+but do not include claims that would be infringed only as a
+consequence of further modification of the contributor version.  For
+purposes of this definition, "control" includes the right to grant
+patent sublicenses in a manner consistent with the requirements of
+this License.
+
+  Each contributor grants you a non-exclusive, worldwide, royalty-free
+patent license under the contributor's essential patent claims, to
+make, use, sell, offer for sale, import and otherwise run, modify and
+propagate the contents of its contributor version.
+
+  In the following three paragraphs, a "patent license" is any express
+agreement or commitment, however denominated, not to enforce a patent
+(such as an express permission to practice a patent or covenant not to
+sue for patent infringement).  To "grant" such a patent license to a
+party means to make such an agreement or commitment not to enforce a
+patent against the party.
+
+  If you convey a covered work, knowingly relying on a patent license,
+and the Corresponding Source of the work is not available for anyone
+to copy, free of charge and under the terms of this License, through a
+publicly available network server or other readily accessible means,
+then you must either (1) cause the Corresponding Source to be so
+available, or (2) arrange to deprive yourself of the benefit of the
+patent license for this particular work, or (3) arrange, in a manner
+consistent with the requirements of this License, to extend the patent
+license to downstream recipients.  "Knowingly relying" means you have
+actual knowledge that, but for the patent license, your conveying the
+covered work in a country, or your recipient's use of the covered work
+in a country, would infringe one or more identifiable patents in that
+country that you have reason to believe are valid.
+
+  If, pursuant to or in connection with a single transaction or
+arrangement, you convey, or propagate by procuring conveyance of, a
+covered work, and grant a patent license to some of the parties
+receiving the covered work authorizing them to use, propagate, modify
+or convey a specific copy of the covered work, then the patent license
+you grant is automatically extended to all recipients of the covered
+work and works based on it.
+
+  A patent license is "discriminatory" if it does not include within
+the scope of its coverage, prohibits the exercise of, or is
+conditioned on the non-exercise of one or more of the rights that are
+specifically granted under this License.  You may not convey a covered
+work if you are a party to an arrangement with a third party that is
+in the business of distributing software, under which you make payment
+to the third party based on the extent of your activity of conveying
+the work, and under which the third party grants, to any of the
+parties who would receive the covered work from you, a discriminatory
+patent license (a) in connection with copies of the covered work
+conveyed by you (or copies made from those copies), or (b) primarily
+for and in connection with specific products or compilations that
+contain the covered work, unless you entered into that arrangement,
+or that patent license was granted, prior to 28 March 2007.
+
+  Nothing in this License shall be construed as excluding or limiting
+any implied license or other defenses to infringement that may
+otherwise be available to you under applicable patent law.
+
+  12. No Surrender of Others' Freedom.
+
+  If conditions are imposed on you (whether by court order, agreement or
+otherwise) that contradict the conditions of this License, they do not
+excuse you from the conditions of this License.  If you cannot convey a
+covered work so as to satisfy simultaneously your obligations under this
+License and any other pertinent obligations, then as a consequence you may
+not convey it at all.  For example, if you agree to terms that obligate you
+to collect a royalty for further conveying from those to whom you convey
+the Program, the only way you could satisfy both those terms and this
+License would be to refrain entirely from conveying the Program.
+
+  13. Remote Network Interaction; Use with the GNU General Public License.
+
+  Notwithstanding any other provision of this License, if you modify the
+Program, your modified version must prominently offer all users
+interacting with it remotely through a computer network (if your version
+supports such interaction) an opportunity to receive the Corresponding
+Source of your version by providing access to the Corresponding Source
+from a network server at no charge, through some standard or customary
+means of facilitating copying of software.  This Corresponding Source
+shall include the Corresponding Source for any work covered by version 3
+of the GNU General Public License that is incorporated pursuant to the
+following paragraph.
+
+  Notwithstanding any other provision of this License, you have
+permission to link or combine any covered work with a work licensed
+under version 3 of the GNU General Public License into a single
+combined work, and to convey the resulting work.  The terms of this
+License will continue to apply to the part which is the covered work,
+but the work with which it is combined will remain governed by version
+3 of the GNU General Public License.
+
+  14. Revised Versions of this License.
+
+  The Free Software Foundation may publish revised and/or new versions of
+the GNU Affero General Public License from time to time.  Such new versions
+will be similar in spirit to the present version, but may differ in detail to
+address new problems or concerns.
+
+  Each version is given a distinguishing version number.  If the
+Program specifies that a certain numbered version of the GNU Affero General
+Public License "or any later version" applies to it, you have the
+option of following the terms and conditions either of that numbered
+version or of any later version published by the Free Software
+Foundation.  If the Program does not specify a version number of the
+GNU Affero General Public License, you may choose any version ever published
+by the Free Software Foundation.
+
+  If the Program specifies that a proxy can decide which future
+versions of the GNU Affero General Public License can be used, that proxy's
+public statement of acceptance of a version permanently authorizes you
+to choose that version for the Program.
+
+  Later license versions may give you additional or different
+permissions.  However, no additional obligations are imposed on any
+author or copyright holder as a result of your choosing to follow a
+later version.
+
+  15. Disclaimer of Warranty.
+
+  THERE IS NO WARRANTY FOR THE PROGRAM, TO THE EXTENT PERMITTED BY
+APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE COPYRIGHT
+HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAM "AS IS" WITHOUT WARRANTY
+OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO,
+THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR
+PURPOSE.  THE ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAM
+IS WITH YOU.  SHOULD THE PROGRAM PROVE DEFECTIVE, YOU ASSUME THE COST OF
+ALL NECESSARY SERVICING, REPAIR OR CORRECTION.
+
+  16. Limitation of Liability.
+
+  IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING
+WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MODIFIES AND/OR CONVEYS
+THE PROGRAM AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY
+GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAMAGES ARISING OUT OF THE
+USE OR INABILITY TO USE THE PROGRAM (INCLUDING BUT NOT LIMITED TO LOSS OF
+DATA OR DATA BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
+PARTIES OR A FAILURE OF THE PROGRAM TO OPERATE WITH ANY OTHER PROGRAMS),
+EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF
+SUCH DAMAGES.
+
+  17. Interpretation of Sections 15 and 16.
+
+  If the disclaimer of warranty and limitation of liability provided
+above cannot be given local legal effect according to their terms,
+reviewing courts shall apply local law that most closely approximates
+an absolute waiver of all civil liability in connection with the
+Program, unless a warranty or assumption of liability accompanies a
+copy of the Program in return for a fee.
+
+                     END OF TERMS AND CONDITIONS
+
+            How to Apply These Terms to Your New Programs
+
+  If you develop a new program, and you want it to be of the greatest
+possible use to the public, the best way to achieve this is to make it
+free software which everyone can redistribute and change under these terms.
+
+  To do so, attach the following notices to the program.  It is safest
+to attach them to the start of each source file to most effectively
+state the exclusion of warranty; and each file should have at least
+the "copyright" line and a pointer to where the full notice is found.
+
+    <one line to give the program's name and a brief idea of what it does.>
+    Copyright (C) <year>  <name of author>
+
+    This program is free software: you can redistribute it and/or modify
+    it under the terms of the GNU Affero General Public License as published by
+    the Free Software Foundation, either version 3 of the License, or
+    (at your option) any later version.
+
+    This program is distributed in the hope that it will be useful,
+    but WITHOUT ANY WARRANTY; without even the implied warranty of
+    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
+    GNU Affero General Public License for more details.
+
+    You should have received a copy of the GNU Affero General Public License
+    along with this program.  If not, see <https://www.gnu.org/licenses/>.
+
+Also add information on how to contact you by electronic and paper mail.
+
+  If your software can interact with users remotely through a computer
+network, you should also make sure that it provides a way for users to
+get its source.  For example, if your program is a web application, its
+interface could display a "Source" link that leads users to an archive
+of the code.  There are many ways you could offer source, and different
+solutions will be better for different programs; see section 13 for the
+specific requirements.
+
+  You should also get your employer (if you work as a programmer) or school,
+if any, to sign a "copyright disclaimer" for the program, if necessary.
+For more information on this, and how to apply and follow the GNU AGPL, see
+<https://www.gnu.org/licenses/>.

MANIFEST.in

@@ -1,2 +0,0 @@
-recursive-include tutorcredentials/patches *
-recursive-include tutorcredentials/templates *

Makefile

@@ -0,0 +1,42 @@
+.DEFAULT_GOAL := help
+.PHONY: docs
+SRC_DIRS = ./tutorcredentials
+
+# Warning: These checks are run on every PR.
+test: test-lint test-types test-format test-pythonpackage   # Run some static checks.
+
+test-format: ## Run code formatting tests.
+	ruff format --check --diff ${SRC_DIRS}
+
+test-lint: ## Run code linting tests
+	ruff check ${SRC_DIRS}
+
+test-types: ## Run type checks.
+	mypy --exclude=templates --ignore-missing-imports --implicit-reexport --strict ${SRC_DIRS}
+
+build-pythonpackage: ## Build the "tutor-credentials" python package for upload to pypi
+	python -m build --sdist
+
+test-pythonpackage: build-pythonpackage ## Test that package can be uploaded to pypi
+	twine check dist/tutor_credentials-$(shell make version).tar.gz
+
+format: ## Format code automatically.
+	ruff format ${SRC_DIRS}
+
+fix-lint: ## Fix lint errors automatically
+	ruff check --fix ${SRC_DIRS}
+
+changelog-entry: ## Create a new changelog entry.
+	scriv create
+
+changelog: ## Collect changelog entries in the CHANGELOG.md file.
+	scriv collect
+
+version: ## Print the current tutor-credentials version
+	@python -c 'import io, os; about = {}; exec(io.open(os.path.join("tutorcredentials", "__about__.py"), "rt", encoding="utf-8").read(), about); print(about["__version__"])'
+
+ESCAPE = 
+help: ## Print this help.
+	@grep -E '^([a-zA-Z_-]+:.*?## .*|######* .+)$$' Makefile \
+		| sed 's/######* \(.*\)/@               $(ESCAPE)[1;31m\1$(ESCAPE)[0m/g' | tr '@' '\n' \
+		| awk 'BEGIN {FS = ":.*?## "}; {printf "\033[33m%-30s\033[0m %s\n", $$1, $$2}'

README.rst

@@ -1,12 +1,12 @@
-Credentials plugin for `Tutor <https://docs.tutor.overhang.io>`__
-===================================================================================
+Credentials plugin for `Tutor <https://docs.tutor.edly.io>`__
+=============================================================
 
-This is a plugin for `Tutor <https://docs.tutor.overhang.io>`_ that integrates the `Credentials <https://github.com/openedx/credentials/>`__ application in an Open edX platform.
+This is a plugin for `Tutor <https://docs.tutor.edly.io>`_ that integrates the `Credentials <https://github.com/openedx/credentials/>`__ application in an Open edX platform.
 Credentials application supports course and program certificates. This plugin offers an admin panel where user can do configurations for the certificates of his course and program.
 
 Note that user will have to create the course/program using `Discovery plugin <https://github.com/overhangio/tutor-discovery>`__. Then Credentials plugin will be used for certificates configurations.
 
-.. image:: https://github.com/overhangio/tutor-credentials/blob/main/doc/django-admin-screen-shot.png
+.. image:: https://github.com/overhangio/tutor-credentials/blob/release/doc/django-admin-screen-shot.png
     :alt: Django Admin
 
 Installation
@@ -16,7 +16,7 @@ Installation
 
     pip install https://github.com/overhangio/tutor-credentials.git
 
-Note that this plugin is compatible with `Kubernetes integration <http://docs.tutor.overhang.io/k8s.html>`__.
+Note that this plugin is compatible with `Kubernetes integration <http://docs.tutor.edly.io/k8s.html>`__.
 
 
 For further instructions on how to setup Credentials with Open edX, check the `Official Credentials documentation <https://readthedocs.org/projects/edx-credentials/>`__.
@@ -38,12 +38,22 @@ For Copying programs that user make in `Discovery plugin <https://github.com/ove
 Using Django Admin
 ~~~~~~~~~~~~~~~~~~
 
-The credentials user interface will be available at http://credentials.local.overhang.io for a local instance, and at ``CREDENTIALS_HOST`` (by  default: ``http(s)://credentials.<your lms host>``) in production. In order to run commands from the UI login with an admin user at: http://credentials.local.overhang.io/admin/. User should be able to authenticate with the same username and password that he used for his lms.
+The credentials user interface will be available at http://credentials.local.openedx.io for a local instance, and at ``CREDENTIALS_HOST`` (by  default: ``http(s)://credentials.<your lms host>``) in production. In order to run commands from the UI login with an admin user at: http://credentials.local.openedx.io/admin/. User should be able to authenticate with the same username and password that he used for his lms.
 User can also create superuser for credentials using the below command
 ::
 
     tutor local run credentials ./manage.py createsuperuser
 
+Learner Record UI
+-----------------
+
+.. image:: https://github.com/overhangio/tutor-credentials/blob/release/doc/learner-record.png
+    :alt: Learner Record MFE screenshot
+
+This plugin installs and enables the `Learner Record MFE <https://github.com/openedx/frontend-app-learner-record>`__ by default.  It contains views for a learners current status in a program, their current grade, and the ability to share any earned credentials either publically or with institutions.
+
+The learner can access the Learner Record UI from their profile page by clicking the "View My Records" button.
+
 Configuration
 -------------
 
@@ -56,43 +66,34 @@ Application configuration
 - ``CREDENTIALS_MYSQL_PASSWORD`` (default: ``"{{ 8|random_string }}"``)
 - ``CREDENTIALS_DOCKER_IMAGE`` (default: ``"{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}"``)
 - ``CREDENTIALS_EXTRA_PIP_REQUIREMENTS`` (default: ``[]``)
-- ``CREDENTIALS_SITE_NAME`` (default: ``"LMS_HOST"``)
 - ``CREDENTIALS_REPOSITORY`` (default: ``"https://github.com/openedx/credentials.git"``)
 - ``CREDENTIALS_REPOSITORY_VERSION`` (default: ``"{{ OPENEDX_COMMON_VERSION }}"``)
 
 Marketing & Theming
 ~~~~~~~~~~~~~~~~~~~
 
-- ``CREDENTIALS_LOGO_TRADEMARK_URL`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.svg"``)
-- ``CREDENTIALS_LOGO_TRADEMARK_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.png"``)
-- ``CREDENTIALS_LOGO_TRADEMARK_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo-trademark.svg"``)
-- ``CREDENTIALS_LOGO_URL`` (default: ``"https://edx-cdn.org/v3/default/logo.svg"``)
-- ``CREDENTIALS_LOGO_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo.png"``)
-- ``CREDENTIALS_LOGO_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo.svg"``)
-- ``CREDENTIALS_LOGO_WHITE_URL`` (default: ``"https://edx-cdn.org/v3/default/logo-white.svg"``)
-- ``CREDENTIALS_LOGO_WHITE_URL_PNG`` (default: ``"https://edx-cdn.org/v3/default/logo-white.png"``)
-- ``CREDENTIALS_LOGO_WHITE_URL_SVG`` (default: ``"https://edx-cdn.org/v3/default/logo-white.svg"``)
-- ``CREDENTIALS_FAVICON_URL`` (default: ``"https://edx-cdn.org/v3/default/favicon.ico"``)
 - ``CREDENTIALS_THEME_NAME`` (default: ``"edx-theme"``)
 
 Backend authentication
-~~~~~~~~~~~~~~~~~~~~~~~
+~~~~~~~~~~~~~~~~~~~~~~
 
 - ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_KEY`` (default: ``"credentials-backend-service-key"``)
 - ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_SECRET`` (default: ``"{{ CREDENTIALS_OAUTH2_SECRET }}"``)
-- ``CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL`` (default: ``"http://lms:8000/oauth2"``)
 - ``CREDENTIALS_OAUTH2_KEY``  (default: ``credentials-backend-service-key"``)
 - ``CREDENTIALS_OAUTH2_SECRET`` (default: ``"CHANGE-ME"``)
 
 Application Third party authentication
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
-- ``CREDENTIALS_SOCIAL_AUTH_REDIRECT_IS_HTTPS`` (default: ``{% if ENABLE_HTTPS %}True{% else %}False{% endif %}``)
-- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_ISSUER`` (default: ``"{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}"``)
-- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT`` (default: ``"http://lms:8000"``)
 - ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_KEY`` (default: ``"credentials-sso-key"``)
 - ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_SECRET`` (default: ``"credentials-sso-secret"``)
-- ``CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL`` (default: ``"{{ SOCIAL_AUTH_EDX_OAUTH2_ISSUER }}/logout"``)
+
+Learner Record UI configuration
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+The Learner Record is configurable dynamically via runtime configuration.  To change any of the variables below, go to your LMS's Django admin Site Configuration page (for instance, http://local.openedx.io/admin/site_configuration/siteconfiguration/) and add or modify corresponding JSON dict entries in the appropriate site:
+
+- ``SUPPORT_URL_LEARNER_RECORDS`` (default: ``""``): the URL the learner is taken to when clicking the "read more in our records help area" link.
 
 Funding
 -------
@@ -106,9 +107,9 @@ This plugin was initially developed and open sourced to the community thanks to
 Troubleshooting
 ---------------
 
-This Tutor plugin is maintained by Muhammad Faraz Maqsood from `Edly <https://edly.io/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.overhang.io/troubleshooting.html>`__ section from the Tutor documentation.
+This Tutor plugin is maintained by Muhammad Labeeb from `Edly <https://edly.io/>`__. Community support is available from the official `Open edX forum <https://discuss.openedx.org>`__. Do you need help with this plugin? See the `troubleshooting <https://docs.tutor.edly.io/troubleshooting.html>`__ section from the Tutor documentation.
 
 License
 -------
 
-This software is licensed under the terms of the AGPLv3.
+This software is licensed under the terms of the `GNU Affero General Public License (AGPL) <https://github.com/overhangio/tutor-credentials/blob/release/LICENSE.txt>`_.

changelog.d/20250808_145509_muhammad.labeeb_migrate_to_ruff.md

@@ -0,0 +1,2 @@
+- [Improvement] Migrate from pylint and black to ruff. (by @mlabeeb03)
+- [Improvement] Test python package distribution build when running make test. (by @mlabeeb03)

changelog.d/fix-mysql-concat.md

@@ -0,0 +1,2 @@
+- [Bugfix] Fixed an issue when syncing `credentials.core_user` to `openedx.auth_user` where the `full_name` field population failed with `ERROR 1292 (22007): Truncated incorrect DOUBLE value: 'FirstName'`.  
+  MySQL does not support string concatenation with `+`, so it was incorrectly treated as a numeric operation. Updated to use `CONCAT()` for proper string concatenation.

linter.sh

@@ -1,11 +0,0 @@
-#!/bin/sh
-#------------------------------------------------------------------------------
-# written by:   mcdaniel
-#               https://lawrencemcdaniel.com
-#
-# date:         mar-2022
-#
-# usage:        run all pre-commit checks.
-#------------------------------------------------------------------------------
-
-pre-commit run --all-files

pyproject.toml

@@ -1,2 +1,86 @@
+# https://packaging.python.org/en/latest/tutorials/packaging-projects/
+# https://hatch.pypa.io/latest/config/build/
+
+[project]
+name = "tutor-credentials"
+license = { text = "AGPL-3.0-only" }
+authors = [
+  {name = "Lawrence McDaniel"},
+  {email = "lpm0073@gmail.com"},
+]
+maintainers = [
+  {name = "Muhammad Labeeb"},
+  {email = "muhammad.labeeb@arbisoft.com"},
+]
+description = "A Tutor plugin for Open edX Credentials service"
+readme = {file = "README.rst", content-type = "text/x-rst"}
+requires-python = ">= 3.9"
+classifiers = [
+    "Development Status :: 5 - Production/Stable",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: GNU Affero General Public License v3",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+  "tutor>=20.0.0,<21.0.0",
+  "tutor-discovery>=20.0.0,<21.0.0", 
+  "tutor-mfe>=20.0.0,<21.0.0"
+]
+# these fields will be set by hatch_build.py
+dynamic = ["version"]
+
+[project.optional-dependencies]
+dev = [
+  "tutor[dev]>=20.0.0,<21.0.0", 
+  "ruff", 
+]
+
+[project.entry-points."tutor.plugin.v1"]
+credentials = "tutorcredentials.plugin"
+
+# https://packaging.python.org/en/latest/specifications/well-known-project-urls/#well-known-labels
+[project.urls]
+Homepage = "https://docs.tutor.edly.io/"
+Documentation = "https://docs.tutor.edly.io/"
+Code = "https://github.com/overhangio/tutor-credentials"
+Issues = "https://github.com/overhangio/tutor-credentials.git/issues"
+Changelog = "https://github.com/overhangio/tutor-credentials/blob/release/CHANGELOG.md"
+Community = "https://discuss.openedx.org/tag/tutor"
+
+# hatch-specific configuration
+[tool.hatch.metadata.hooks.custom]
+path = ".hatch_build.py"
+
 [build-system]
-requires = ["setuptools", "wheel"]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.sdist]
+# Disable strict naming, otherwise twine is not able to detect name/version
+strict-naming = false
+include = [ "/tutorcredentials", '.hatch_build.py']
+exclude = ["tests*"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["tutorcredentials"]
+
+[tool.ruff]
+exclude = ["templates", "docs/_ext"]
+
+[tool.ruff.lint]
+# E: pycodestyle errors
+# I: isort
+# N: pep8-naming
+select = ["E", "I", "N"]
+
+# F401: unused-import
+# F841: unused-variable
+# W292: missing-newline-at-end-of-file
+extend-select = ["F401", "F841", "W292"]
+
+[tool.ruff.format]

requirements.txt

@@ -1 +0,0 @@
-pre-commit

setup.py

@@ -1,60 +0,0 @@
-import io
-import os
-from setuptools import setup, find_packages
-
-HERE = os.path.abspath(os.path.dirname(__file__))
-
-
-def load_readme():
-    with io.open(os.path.join(HERE, "README.rst"), "rt", encoding="utf8") as f:
-        return f.read()
-
-
-def load_about():
-    about = {}
-    with io.open(
-        os.path.join(HERE, "tutorcredentials", "__about__.py"),
-        "rt",
-        encoding="utf-8",
-    ) as f:
-        exec(f.read(), about)  # pylint: disable=exec-used
-    return about
-
-
-ABOUT = load_about()
-
-
-setup(
-    name="tutor-credentials",
-    version=ABOUT["__version__"],
-    url="https://github.com/overhangio/tutor-credentials.git",
-    project_urls={
-        "Code": "https://github.com/overhangio/tutor-credentials.git",
-        "Issue tracker": "https://github.com/overhangio/tutor-credentials.git/issues",
-        "Community": "https://discuss.overhang.io",
-    },
-    license="AGPLv3",
-    author="Lawrence McDaniel",
-    author_email="lpm0073@gmail.com",
-    maintainer="Edly",
-    maintainer_email="faraz.maqsood@arbisoft.com",
-    description="A Tutor plugin for Open edX Credentials service",
-    long_description=load_readme(),
-    packages=find_packages(exclude=["tests*"]),
-    include_package_data=True,
-    python_requires=">=3.8",
-    install_requires=["tutor>=16.0.0,<17.0.0", "tutor-discovery>=16.0.0,<17.0.0", "tutor-mfe>=16.0.0,<17.0.0"],
-    entry_points={"tutor.plugin.v1": ["credentials = tutorcredentials.plugin"]},
-    classifiers=[
-        "Development Status :: 5 - Production/Stable",
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: GNU Affero General Public License v3",
-        "Operating System :: OS Independent",
-        "Programming Language :: Python",
-        "Programming Language :: Python :: 3.8",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3.11",
-        "Programming Language :: Python :: 3.12",
-    ],
-)

tutorcredentials/__about__.py

@@ -1,2 +1 @@
-__version__ = "16.0.3"
-
+__version__ = "20.0.0"

tutorcredentials/patches/k8s-deployments

@@ -15,8 +15,8 @@ spec:
         app.kubernetes.io/name: credentials
     spec:
       securityContext:
-        runAsUser: 1000
-        runAsGroup: 1000
+        runAsUser: {{ APP_USER_ID }}
+        runAsGroup: {{ APP_USER_ID }}
       containers:
         - name: credentials
           image: {{ CREDENTIALS_DOCKER_IMAGE }}

tutorcredentials/patches/local-docker-compose-dev-services

@@ -9,6 +9,9 @@ credentials:
   volumes:
     # editable requirements
     - ../plugins/credentials/build/credentials/requirements:/openedx/requirements
+    {%- for mount in iter_mounts(MOUNTS, "credentials") %}
+    - {{ mount }}
+    {%- endfor %}
   networks:
     default:
       aliases:

tutorcredentials/patches/mfe-env-development

@@ -1 +0,0 @@
-CREDENTIALS_BASE_URL='http://{{ CREDENTIALS_HOST }}:8150'

tutorcredentials/patches/mfe-env-production

@@ -1 +0,0 @@
-CREDENTIALS_BASE_URL='{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ CREDENTIALS_HOST }}'

tutorcredentials/patches/openedx-lms-common-settings

@@ -0,0 +1 @@
+CREDENTIALS_SERVICE_USERNAME = "{{ CREDENTIALS_SERVICE_USERNAME }}"

tutorcredentials/patches/openedx-lms-development-settings

@@ -1,2 +1,6 @@
-CREDENTIALS_PUBLIC_URL_ROOT = "http://{{ CREDENTIALS_HOST }}:8150"
-CREDENTIALS_API_URL = CREDENTIALS_PUBLIC_URL_ROOT + "/api/v2"
+CREDENTIALS_INTERNAL_SERVICE_URL = 'http://{{ CREDENTIALS_HOST }}:8150'
+CREDENTIALS_PUBLIC_SERVICE_URL = CREDENTIALS_INTERNAL_SERVICE_URL
+MFE_CONFIG["CREDENTIALS_BASE_URL"] = CREDENTIALS_INTERNAL_SERVICE_URL
+MFE_CONFIG["SUPPORT_URL_LEARNER_RECORDS"] = ''
+MFE_CONFIG["ENABLE_VERIFIABLE_CREDENTIALS"] = False
+MFE_CONFIG["SUPPORT_URL_VERIFIABLE_CREDENTIALS"] = ''

tutorcredentials/patches/openedx-lms-production-settings

@@ -1,2 +1,6 @@
-CREDENTIALS_PUBLIC_URL_ROOT = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ CREDENTIALS_HOST }}"
-CREDENTIALS_API_URL = CREDENTIALS_PUBLIC_URL_ROOT + "/api/v2"
+CREDENTIALS_INTERNAL_SERVICE_URL = '{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ CREDENTIALS_HOST }}'
+CREDENTIALS_PUBLIC_SERVICE_URL = CREDENTIALS_INTERNAL_SERVICE_URL
+MFE_CONFIG["CREDENTIALS_BASE_URL"] = CREDENTIALS_INTERNAL_SERVICE_URL
+MFE_CONFIG["SUPPORT_URL_LEARNER_RECORDS"] = ''
+MFE_CONFIG["ENABLE_VERIFIABLE_CREDENTIALS"] = False
+MFE_CONFIG["SUPPORT_URL_VERIFIABLE_CREDENTIALS"] = ''

tutorcredentials/plugin.py

@@ -1,16 +1,17 @@
 from __future__ import annotations
 
-from glob import glob
 import os
-import pkg_resources
 import typing as t
+from glob import glob
 
+import importlib_resources
 from tutor import hooks as tutor_hooks
 from tutor.__about__ import __version_suffix__
+from tutormfe.hooks import MFE_APPS, MFE_ATTRS_TYPE
 
 from .__about__ import __version__
 
-# Handle version suffix in nightly mode, just like tutor core
+# Handle version suffix in main mode, just like tutor core
 if __version_suffix__:
     __version__ += "-" + __version_suffix__
 
@@ -19,100 +20,103 @@ if __version_suffix__:
 # CONFIGURATION
 ########################################
 
+config: t.Dict[str, t.Dict[str, t.Any]] = {
+    "defaults": {
+        "VERSION": __version__,
+        "BACKEND_SERVICE_EDX_OAUTH2_KEY": "{{ CREDENTIALS_OAUTH2_KEY }}",
+        "DOCKER_IMAGE": "{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}",  # noqa: E501
+        "EXTRA_PIP_REQUIREMENTS": [],
+        "HOST": "credentials.{{ LMS_HOST }}",
+        "MYSQL_DATABASE": "credentials",
+        "MYSQL_USERNAME": "credentials",
+        "OAUTH2_KEY": "credentials-key",
+        "OAUTH2_KEY_DEV": "credentials-key-dev",
+        "OAUTH2_KEY_SSO": "credentials-key-sso",
+        "OAUTH2_KEY_SSO_DEV": "credentials-key-sso-dev",
+        "SOCIAL_AUTH_EDX_OAUTH2_KEY": "credentials-sso-key",
+        "THEME_NAME": "edx-theme",
+        "REPOSITORY": "https://github.com/openedx/credentials.git",
+        "REPOSITORY_VERSION": "{{ OPENEDX_COMMON_VERSION }}",
+        "SERVICE_USERNAME": "credentials",
+    },
+    "unique": {
+        "MYSQL_PASSWORD": "{{ 8|random_string }}",
+        "SOCIAL_AUTH_EDX_OAUTH2_SECRET": "{{ 16|random_string }}",
+        "BACKEND_SERVICE_EDX_OAUTH2_SECRET": "{{ 16|random_string }}",
+        "OAUTH2_SECRET": "{{ 16|random_string }}",
+        "OAUTH2_SECRET_DEV": "{{ 16|random_string }}",
+        "OAUTH2_SECRET_SSO": "{{ 16|random_string }}",
+        "OAUTH2_SECRET_SSO_DEV": "{{ 16|random_string }}",
+    },
+}
+
 tutor_hooks.Filters.CONFIG_DEFAULTS.add_items(
-    [
-        # Add your new settings that have default values here.
-        # Each new setting is a pair, (setting_name, default_value).
-        # Prefix your setting names with 'CREDENTIALS_'.
-        ("CREDENTIALS_VERSION", __version__),
-        ("CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_PROVIDER_URL", "http://lms:8000/oauth2"),
-        ("CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_KEY", "{{ CREDENTIALS_OAUTH2_KEY }}"),
-        ("CREDENTIALS_DOCKER_IMAGE", "{{ DOCKER_REGISTRY }}overhangio/openedx-credentials:{{ CREDENTIALS_VERSION }}"),
-        ("CREDENTIALS_EXTRA_PIP_REQUIREMENTS", []),
-        ("CREDENTIALS_FAVICON_URL", "https://edx-cdn.org/v3/default/favicon.ico"),
-        ("CREDENTIALS_HOST", "credentials.{{ LMS_HOST }}"),
-        ("CREDENTIALS_LOGO_TRADEMARK_URL", "https://edx-cdn.org/v3/default/logo-trademark.svg"),
-        ("CREDENTIALS_LOGO_TRADEMARK_URL_PNG", "https://edx-cdn.org/v3/default/logo-trademark.png"),
-        ("CREDENTIALS_LOGO_TRADEMARK_URL_SVG", "https://edx-cdn.org/v3/default/logo-trademark.svg"),
-        ("CREDENTIALS_LOGO_URL", ""),
-        ("CREDENTIALS_LOGO_URL_PNG", "{{ CREDENTIALS_LOGO_URL }}"),
-        ("CREDENTIALS_LOGO_URL_SVG", ""),
-        ("CREDENTIALS_LOGO_WHITE_URL", "{{ CREDENTIALS_LOGO_URL }}"),
-        ("CREDENTIALS_LOGO_WHITE_URL_PNG", "{{ CREDENTIALS_LOGO_URL }}"),
-        ("CREDENTIALS_LOGO_WHITE_URL_SVG", ""),
-        ("CREDENTIALS_MYSQL_DATABASE", "credentials"),
-        ("CREDENTIALS_MYSQL_USERNAME", "credentials"),
-        ("CREDENTIALS_OAUTH2_KEY", "credentials-key"),
-        ("CREDENTIALS_OAUTH2_KEY_DEV", "credentials-key-dev"),
-        ("CREDENTIALS_OAUTH2_KEY_SSO", "credentials-key-sso"),
-        ("CREDENTIALS_OAUTH2_KEY_SSO_DEV", "credentials-key-sso-dev"),
-        ("CREDENTIALS_PLATFORM_NAME", "{{ PLATFORM_NAME }}"),
-        ("CREDENTIALS_SITE_NAME", "{{ LMS_HOST }}"),
-        ("CREDENTIALS_SOCIAL_AUTH_REDIRECT_IS_HTTPS", False),
-        ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_ISSUER", "https://{{ LMS_HOST }}"),
-        ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_URL_ROOT", "http://lms:8000"),
-        ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_KEY", "credentials-sso-key"),
-        ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_LOGOUT_URL", "{{ LMS_HOST }}/logout"),
-        ("CREDENTIALS_THEME_NAME", "edx-theme"),
-        ("CREDENTIALS_REPOSITORY", "https://github.com/openedx/credentials.git"),
-        ("CREDENTIALS_REPOSITORY_VERSION", "{{ OPENEDX_COMMON_VERSION }}"),
-    ]
+    [(f"CREDENTIALS_{key}", value) for key, value in config.get("defaults", {}).items()]
 )
-
 tutor_hooks.Filters.CONFIG_UNIQUE.add_items(
-    [
-        # Add settings that don't have a reasonable default for all users here.
-        # For instance, passwords, secret keys, etc.
-        # Each new setting is a pair, (setting_name, unique_generated_value).
-        # Prefix your setting names with 'CREDENTIALS_'.
-        # For example:
-        ("CREDENTIALS_MYSQL_PASSWORD", "{{ 8|random_string }}"),
-        ("CREDENTIALS_SOCIAL_AUTH_EDX_OAUTH2_SECRET", "{{ 16|random_string }}"),
-        ("CREDENTIALS_BACKEND_SERVICE_EDX_OAUTH2_SECRET", "{{ 16|random_string }}"),
-        ("CREDENTIALS_OAUTH2_SECRET", "{{ 16|random_string }}"),
-        ("CREDENTIALS_OAUTH2_SECRET_DEV", "{{ 16|random_string }}"),
-        ("CREDENTIALS_OAUTH2_SECRET_SSO", "{{ 16|random_string }}"),
-        ("CREDENTIALS_OAUTH2_SECRET_SSO_DEV", "{{ 16|random_string }}"),
-    ]
+    [(f"CREDENTIALS_{key}", value) for key, value in config.get("unique", {}).items()]
+)
+tutor_hooks.Filters.CONFIG_OVERRIDES.add_items(
+    list(config.get("overrides", {}).items())
 )
 
-tutor_hooks.Filters.CONFIG_OVERRIDES.add_items(
-    [
-        # Danger zone!
-        # Add values to override settings from Tutor core or other plugins here.
-        # Each override is a pair, (setting_name, new_value). For example:
-        # ("PLATFORM_NAME", "My platform"),
-    ]
-)
+
+########################################
+# MFEs
+########################################
+
+
+@MFE_APPS.add()  # type: ignore
+def _add_learner_record_mfe(
+    apps: dict[str, MFE_ATTRS_TYPE],
+) -> dict[str, MFE_ATTRS_TYPE]:
+    apps.update(
+        {
+            "learner-record": {
+                "repository": "https://github.com/openedx/frontend-app-learner-record.git",
+                "port": 1990,
+            },
+        }
+    )
+    return apps
 
 
 ########################################
 # INITIALIZATION TASKS
 ########################################
 
-# To run the script from templates/credentials/tasks/myservice/init, add:
 MY_INIT_TASKS = [
-    ("mysql", ("templates", "credentials", "tasks", "mysql", "init")),
-    ("lms", ("templates", "credentials", "tasks", "lms", "init")),
-    ("credentials", ("templates", "credentials", "tasks", "credentials", "init")),
-    ("mysql", ("templates", "credentials", "tasks", "mysql", "sync_users")),
+    ("mysql", "init"),
+    ("lms", "init"),
+    ("credentials", "init"),
+    ("mysql", "sync_users"),
 ]
 
 HERE = os.path.abspath(os.path.dirname(__file__))
-for service, template_path in MY_INIT_TASKS:
-    full_path: str = os.path.join(HERE, *template_path)
+for service, template_name in MY_INIT_TASKS:
+    full_path: str = str(
+        importlib_resources.files("tutorcredentials")
+        / "templates"
+        / "credentials"
+        / "tasks"
+        / service
+        / template_name
+    )
 
     with open(full_path, encoding="utf-8") as init_task_file:
         init_task: str = init_task_file.read()
         tutor_hooks.Filters.CLI_DO_INIT_TASKS.add_item((service, init_task))
 
+
 ########################################
 # Credentials Public Host
 ########################################
 
 
 @tutor_hooks.Filters.APP_PUBLIC_HOSTS.add()
-def _print_credentials_public_hosts(hosts: list[str], context_name: t.Literal["local", "dev"]) -> list[str]:
+def _print_credentials_public_hosts(
+    hosts: list[str], context_name: t.Literal["local", "dev"]
+) -> list[str]:
     if context_name == "dev":
         hosts += ["{{ CREDENTIALS_HOST }}:8150"]
     else:
@@ -129,7 +133,9 @@ REPO_NAME = "credentials"
 
 # Automount /openedx/credentials folder from the container
 @tutor_hooks.Filters.COMPOSE_MOUNTS.add()
-def _mount_credentials_apps(mounts, path_basename):
+def _mount_credentials_apps(
+    mounts: list[tuple[str, str]], path_basename: str
+) -> list[tuple[str, str]]:
     if path_basename == REPO_NAME:
         app_name = REPO_NAME
         mounts += [(app_name, "/openedx/credentials")]
@@ -138,7 +144,9 @@ def _mount_credentials_apps(mounts, path_basename):
 
 # Bind-mount repo at build-time, both for prod and dev images
 @tutor_hooks.Filters.IMAGES_BUILD_MOUNTS.add()
-def _mount_credentials_on_build(mounts: list[tuple[str, str]], host_path: str) -> list[tuple[str, str]]:
+def _mount_credentials_on_build(
+    mounts: list[tuple[str, str]], host_path: str
+) -> list[tuple[str, str]]:
     path_basename = os.path.basename(host_path)
     if path_basename == REPO_NAME:
         app_name = REPO_NAME
@@ -151,7 +159,6 @@ def _mount_credentials_on_build(mounts: list[tuple[str, str]], host_path: str) -
 # DOCKER IMAGE MANAGEMENT
 ########################################
 
-# To build an image with `tutor images build myimage`, add a Dockerfile to templates/credentials/build/myimage and write:
 tutor_hooks.Filters.IMAGES_BUILD.add_item(
     (
         "credentials",
@@ -160,36 +167,30 @@ tutor_hooks.Filters.IMAGES_BUILD.add_item(
         (),
     )
 )
-
-
-# To pull/push an image with `tutor images pull myimage` and `tutor images push myimage`, write:
-# tutor_hooks.Filters.IMAGES_PULL.add_item((
-#     "myimage",
-#     "docker.io/myimage:{{ CREDENTIALS_VERSION }}",
-# )
-# tutor_hooks.Filters.IMAGES_PUSH.add_item((
-#     "myimage",
-#     "docker.io/myimage:{{ CREDENTIALS_VERSION }}",
-# )
+tutor_hooks.Filters.IMAGES_PULL.add_item(
+    (
+        "credentials",
+        "{{ CREDENTIALS_DOCKER_IMAGE }}",
+    )
+)
+tutor_hooks.Filters.IMAGES_PUSH.add_item(
+    (
+        "credentials",
+        "{{ CREDENTIALS_DOCKER_IMAGE }}",
+    )
+)
 
 
 ########################################
 # TEMPLATE RENDERING
-# (It is safe & recommended to leave
-#  this section as-is :)
 ########################################
 
-tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_items(
-    # Root paths for template files, relative to the project root.
-    [
-        pkg_resources.resource_filename("tutorcredentials", "templates"),
-    ]
+tutor_hooks.Filters.ENV_TEMPLATE_ROOTS.add_item(
+    # Root path for template files, relative to the project root.
+    str(importlib_resources.files("tutorcredentials") / "templates")
 )
 
 tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
-    # For each pair (source_path, destination_path):
-    # templates at ``source_path`` (relative to your ENV_TEMPLATE_ROOTS) will be
-    # rendered to ``destination_path`` (relative to your Tutor environment).
     [
         ("credentials/build", "plugins"),
         ("credentials/apps", "plugins"),
@@ -199,17 +200,10 @@ tutor_hooks.Filters.ENV_TEMPLATE_TARGETS.add_items(
 
 ########################################
 # PATCH LOADING
-# (It is safe & recommended to leave
-#  this section as-is :)
 ########################################
 
-# For each file in tutorcredentials/patches,
-# apply a patch based on the file's name and contents.
-for path in glob(
-    os.path.join(
-        pkg_resources.resource_filename("tutorcredentials", "patches"),
-        "*",
-    )
-):
+for path in glob(str(importlib_resources.files("tutorcredentials") / "patches" / "*")):
     with open(path, encoding="utf-8") as patch_file:
-        tutor_hooks.Filters.ENV_PATCHES.add_item((os.path.basename(path), patch_file.read()))
+        tutor_hooks.Filters.ENV_PATCHES.add_item(
+            (os.path.basename(path), patch_file.read())
+        )

tutorcredentials/templates/credentials/apps/credentials/settings/development.py

@@ -2,7 +2,18 @@ from credentials.settings.devstack import * # pylint: disable=wildcard-import, u
 
 {% include "credentials/apps/credentials/settings/partials/common.py" %}
 
-SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}:8000"
+FAVICON_URL = "http://{{ LMS_HOST }}:8000/favicon.ico"
+
+CORS_ORIGIN_WHITELIST = list(CORS_ORIGIN_WHITELIST) + [
+    "http://{{ MFE_HOST }}:{{ get_mfe('learner-record')['port'] }}",
+]
+CSRF_TRUSTED_ORIGINS = ["http://{{ MFE_HOST }}:{{ get_mfe('learner-record')['port'] }}"]
+
+LEARNER_RECORD_MFE_RECORDS_PAGE_URL = "http://{{ MFE_HOST }}:{{ get_mfe('learner-record')['port'] }}/learner-record/"
+
+SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = "http://{{ LMS_HOST }}:8000"
+SOCIAL_AUTH_EDX_OAUTH2_KEY = "{{ CREDENTIALS_OAUTH2_KEY_SSO_DEV }}"
+SOCIAL_AUTH_EDX_OAUTH2_SECRET = "{{ CREDENTIALS_OAUTH2_SECRET_SSO_DEV }}"
 
 BACKEND_SERVICE_EDX_OAUTH2_KEY = "{{ CREDENTIALS_OAUTH2_KEY }}"
 

tutorcredentials/templates/credentials/apps/credentials/settings/partials/common.py

@@ -36,16 +36,16 @@ JWT_AUTH["JWT_ISSUERS"] = [
     }
 ]
 
-LOGO_TRADEMARK_URL = "https://edx-cdn.org/v3/default/logo-trademark.svg"
-LOGO_TRADEMARK_URL_PNG = "https://edx-cdn.org/v3/default/logo-trademark.png"
-LOGO_TRADEMARK_URL_SVG = "https://edx-cdn.org/v3/default/logo-trademark.svg"
-LOGO_URL = "https://edx-cdn.org/v3/default/logo.svg"
-LOGO_URL_PNG = "https://edx-cdn.org/v3/default/logo.png"
-LOGO_URL_SVG = "https://edx-cdn.org/v3/default/logo.svg"
-LOGO_WHITE_URL = "https://edx-cdn.org/v3/default/logo-white.svg"
-LOGO_WHITE_URL_PNG = "https://edx-cdn.org/v3/default/logo-white.png"
-LOGO_WHITE_URL_SVG = "https://edx-cdn.org/v3/default/logo-white.svg"
-FAVICON_URL = "https://edx-cdn.org/v3/default/favicon.ico"
+LOGO_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/theming/asset/images/logo.png"
+LOGO_TRADEMARK_URL = LOGO_URL
+LOGO_TRADEMARK_URL_PNG = LOGO_URL
+LOGO_TRADEMARK_URL_SVG = LOGO_URL
+LOGO_URL_PNG = LOGO_URL
+LOGO_URL_SVG = LOGO_URL
+LOGO_WHITE_URL = LOGO_URL
+LOGO_WHITE_URL_PNG = LOGO_URL
+LOGO_WHITE_URL_SVG = LOGO_URL
+FAVICON_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/favicon.ico"
 
 SOCIAL_AUTH_REDIRECT_IS_HTTPS = {% if ENABLE_HTTPS %}True{% else %}False{% endif %}
 SOCIAL_AUTH_EDX_OAUTH2_ISSUER = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}"
@@ -83,8 +83,8 @@ EMAIL_HOST_USER = "{{ SMTP_USERNAME }}"
 EMAIL_HOST_PASSWORD = "{{ SMTP_PASSWORD }}"
 EMAIL_USE_TLS = {{SMTP_USE_TLS}}
 
-#USE_LEARNER_RECORD_MFE = False
-#LEARNER_RECORD_MFE_RECORDS_PAGE_URL = ""
+USE_LEARNER_RECORD_MFE = True
+ENABLE_VERIFIABLE_CREDENTIALS = False
 
 # reconfigure logging and Get rid of local logger
 LOGGING = get_logger_config(debug=False, dev_env=True, local_loglevel="INFO")

tutorcredentials/templates/credentials/apps/credentials/settings/production.py

@@ -2,7 +2,16 @@ from credentials.settings.production import * # pylint: disable=wildcard-import,
 
 {% include "credentials/apps/credentials/settings/partials/common.py" %}
 
+CORS_ORIGIN_WHITELIST = list(CORS_ORIGIN_WHITELIST) + [
+    "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ MFE_HOST }}",
+]
+CSRF_TRUSTED_ORIGINS = ["{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ MFE_HOST }}"]
+
+LEARNER_RECORD_MFE_RECORDS_PAGE_URL = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ MFE_HOST }}/learner-record/"
+
 SOCIAL_AUTH_EDX_OAUTH2_PUBLIC_URL_ROOT = "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}"
+SOCIAL_AUTH_EDX_OAUTH2_KEY = "{{ CREDENTIALS_OAUTH2_KEY_SSO }}"
+SOCIAL_AUTH_EDX_OAUTH2_SECRET = "{{ CREDENTIALS_OAUTH2_SECRET_SSO }}"
 
 BACKEND_SERVICE_EDX_OAUTH2_KEY = "{{ CREDENTIALS_OAUTH2_KEY }}"
 

tutorcredentials/templates/credentials/build/credentials/Dockerfile

@@ -1,33 +1,35 @@
-{% if is_buildkit_enabled() %}# syntax=docker/dockerfile:1.4{% endif %}
+# syntax=docker/dockerfile:1
 ###### Minimal image with base system requirements for most stages
-FROM docker.io/ubuntu:20.04 as minimal
-LABEL maintainer="Lawrence McDaniel <lpm0073@gmail.com>"
+FROM docker.io/ubuntu:24.04 AS minimal
 
 ENV DEBIAN_FRONTEND=noninteractive
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
-    --mount=type=cache,target=/var/lib/apt,sharing=locked{% endif %} \
-    apt update && \
-    apt install -y build-essential curl git language-pack-en
 
-ENV LC_ALL en_US.UTF-8
+# Delete default UID=1000 `ubuntu` user to ensure we can use id 1000 for app user
+RUN userdel -r ubuntu
+
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked \
+    apt update && \
+    apt install -y build-essential curl git language-pack-en gettext
+
+ENV LC_ALL=en_US.UTF-8
 {{ patch("credentials-dockerfile-minimal") }}
 
-
 ###### Install python with pyenv in /opt/pyenv and create virtualenv in /openedx/venv
-FROM minimal as python
+FROM minimal AS python
 # https://github.com/pyenv/pyenv/wiki/Common-build-problems#prerequisites
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
-    --mount=type=cache,target=/var/lib/apt,sharing=locked {% endif %}apt update && \
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked apt update && \
     apt install -y libssl-dev zlib1g-dev libbz2-dev \
     libreadline-dev libsqlite3-dev wget curl llvm libncurses5-dev libncursesw5-dev \
-    xz-utils tk-dev libffi-dev liblzma-dev python-openssl git
+    xz-utils tk-dev libffi-dev liblzma-dev python3-openssl git
 
 # Install pyenv
 # https://www.python.org/downloads/
 # https://github.com/pyenv/pyenv/releases
-ARG PYTHON_VERSION=3.8.15
-ENV PYENV_ROOT /opt/pyenv
-RUN git clone https://github.com/pyenv/pyenv $PYENV_ROOT --branch v2.3.17 --depth 1
+ARG PYTHON_VERSION=3.11.9
+ENV PYENV_ROOT=/opt/pyenv
+RUN git clone https://github.com/pyenv/pyenv $PYENV_ROOT --branch v2.4.0 --depth 1
 
 # Install Python
 RUN $PYENV_ROOT/bin/pyenv install $PYTHON_VERSION
@@ -36,7 +38,10 @@ RUN $PYENV_ROOT/bin/pyenv install $PYTHON_VERSION
 RUN $PYENV_ROOT/versions/$PYTHON_VERSION/bin/python -m venv /openedx/venv
 
 ###### Checkout credentials
-FROM minimal as code
+FROM minimal AS code
+# Below warnings will occurr due to the variable name(have word "credentials" in it).
+# - SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ARG "CREDENTIALS_REPOSITORY") (line 41)
+# - SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ARG "CREDENTIALS_VERSION") (line 42)
 ARG CREDENTIALS_REPOSITORY="{{ CREDENTIALS_REPOSITORY }}"
 ARG CREDENTIALS_VERSION="{{ CREDENTIALS_REPOSITORY_VERSION }}"
 RUN mkdir -p /openedx/credentials && \
@@ -45,26 +50,14 @@ WORKDIR /openedx/credentials
 
 {{ patch("credentials-dockerfile-post-git-checkout") }}
 
-###### Download extra locales to /openedx/locale/contrib/locale
-# mcdaniel: including these just in case there are implied dependencies
-# on emitted credential data, which would be platform specific obviously.
-FROM minimal as locales
-ARG OPENEDX_I18N_VERSION="{{ OPENEDX_COMMON_VERSION }}"
-RUN cd /tmp \
-    && curl -L -o openedx-i18n.tar.gz https://github.com/openedx/openedx-i18n/archive/$OPENEDX_I18N_VERSION.tar.gz \
-    && tar xzf /tmp/openedx-i18n.tar.gz \
-    && mkdir -p /openedx/locale/contrib \
-    && mv openedx-i18n-*/edx-platform/locale /openedx/locale/contrib \
-    && rm -rf openedx-i18n*
-
 ###### Install python requirements in virtualenv
-FROM python as python-requirements
-ENV PATH /openedx/venv/bin:${PATH}
-ENV VIRTUAL_ENV /openedx/venv/
+FROM python AS python-requirements
+ENV PATH=/openedx/venv/bin:${PATH}
+ENV VIRTUAL_ENV=/openedx/venv/
 
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
-    --mount=type=cache,target=/var/lib/apt,sharing=locked {% endif %}apt update \
-    && apt install -y software-properties-common libmysqlclient-dev libxmlsec1-dev libgeos-dev
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked apt update \
+    && apt install -y software-properties-common libmysqlclient-dev libxmlsec1-dev
 
 # Note that this means that we need to reinstall all requirements whenever there is a
 # change in credentials, which sucks. But there is no obvious alternative, as we need
@@ -73,98 +66,89 @@ COPY --from=code /openedx/credentials /openedx/credentials
 WORKDIR /openedx/credentials
 
 # Install the right version of pip/setuptools
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install \
+RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install \
     # https://pypi.org/project/setuptools/
     # https://pypi.org/project/pip/
     # https://pypi.org/project/wheel/
-    setuptools==67.7.2 pip==23.1.2. wheel==0.40.0
+    setuptools==77.0.3 pip==25.0.1 wheel==0.45.1
 
 # Install base requirements
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install -r requirements/pip_tools.txt
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install -r requirements.txt
+RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install -r requirements/production.txt
 
 # Install extra requirements
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install \
+RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install \
     # Use redis as a django cache https://pypi.org/project/django-redis/
-    django-redis==5.2.0 \
+    django-redis==5.4.0 \
     # uwsgi server https://pypi.org/project/uWSGI/
-    uwsgi==2.0.21
+    uwsgi==2.0.28
 
 {{ patch("credentials-dockerfile-post-python-requirements") }}
 
-# Install private requirements: this is useful for installing custom xblocks.
-COPY ./requirements/ /openedx/requirements
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}cd /openedx/requirements/ \
-  && touch ./private.txt \
-  && pip install -r ./private.txt
-
-{% for extra_requirement in CREDENTIALS_EXTRA_PIP_REQUIREMENTS %}RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.cache/pip,sharing=shared {% endif %}pip install '{{ extra_requirement }}'
+{% for extra_requirement in CREDENTIALS_EXTRA_PIP_REQUIREMENTS %}RUN --mount=type=cache,target=/openedx/.cache/pip,sharing=shared pip install '{{ extra_requirement }}'
 {% endfor %}
 
 ###### Install nodejs with nodeenv in /openedx/nodeenv
-FROM python as nodejs-requirements
-ENV PATH /openedx/nodeenv/bin:/openedx/venv/bin:${PATH}
+FROM python AS nodejs-requirements
+ENV PATH=/openedx/nodeenv/bin:/openedx/venv/bin:${PATH}
 
 # Install nodeenv with the version provided by credentials
-# https://github.com/pyenv/pyenv/releases
-RUN pip install nodeenv==1.7.0
-RUN nodeenv /openedx/nodeenv --node=16.14.0 --prebuilt
+# https://github.com/ekalinin/nodeenv/releases
+RUN pip install nodeenv==1.8.0
+RUN nodeenv /openedx/nodeenv --node=16.14.2 --prebuilt
 
 # Install nodejs requirements
 ARG NPM_REGISTRY='{{ NPM_REGISTRY }}'
 COPY --from=code /openedx/credentials/package.json /openedx/credentials/package.json
 WORKDIR /openedx/credentials
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/openedx/.npm/,sharing=shared {% endif %}npm install --verbose --registry=$NPM_REGISTRY
+RUN --mount=type=cache,target=/openedx/.npm/,sharing=shared npm install --verbose --registry=$NPM_REGISTRY
 
 ###### Production image with system and python requirements
-FROM minimal as production
+FROM minimal AS production
 
 # Install system requirements
-# mcdaniel: these are the edx-platform system requirements.
-# TO DO: remove any packages that are not needed for Credentials.
-RUN {% if is_buildkit_enabled() %}--mount=type=cache,target=/var/cache/apt,sharing=locked \
-    --mount=type=cache,target=/var/lib/apt,sharing=locked {% endif %}apt update \
-    && apt install -y gettext gfortran graphviz graphviz-dev libffi-dev libfreetype6-dev libgeos-dev libjpeg8-dev liblapack-dev libmysqlclient-dev libpng-dev libsqlite3-dev libxmlsec1-dev lynx mysql-client ntp pkg-config rdfind
+RUN --mount=type=cache,target=/var/cache/apt,sharing=locked \
+    --mount=type=cache,target=/var/lib/apt,sharing=locked apt update \
+    && apt install -y libxml2 libmysqlclient-dev media-types mailcap
 
 # From then on, run as unprivileged "app" user
-ARG APP_USER_ID=1000
+ARG APP_USER_ID={{ HOST_USER_ID }}
 RUN if [ "$APP_USER_ID" = 0 ]; then echo "app user may not be root" && false; fi
 RUN useradd --home-dir /openedx --create-home --shell /bin/bash --uid ${APP_USER_ID} app
 USER ${APP_USER_ID}
 
-# change file ownership to the new app user
+# Change file ownership to the new app user
 COPY --chown=app:app --from=code /openedx/credentials /openedx/credentials
-COPY --chown=app:app --from=locales /openedx/locale /openedx/locale
 COPY --chown=app:app --from=python /opt/pyenv /opt/pyenv
 COPY --chown=app:app --from=python-requirements /openedx/venv /openedx/venv
-COPY --chown=app:app --from=python-requirements /openedx/requirements /openedx/requirements
 COPY --chown=app:app --from=nodejs-requirements /openedx/nodeenv /openedx/nodeenv
 COPY --chown=app:app --from=nodejs-requirements /openedx/credentials/node_modules /openedx/node_modules
 
 # Symlink node_modules such that we can bind-mount the credentials repository
 RUN ln -s /openedx/node_modules /openedx/credentials/node_modules
 
-ENV PATH /openedx/venv/bin:./node_modules/.bin:/openedx/nodeenv/bin:${PATH}
-ENV VIRTUAL_ENV /openedx/venv/
+ENV PATH=/openedx/venv/bin:./node_modules/.bin:/openedx/nodeenv/bin:${PATH}
+ENV VIRTUAL_ENV=/openedx/venv/
 WORKDIR /openedx/credentials
 
-# Re-install local requirements, otherwise egg-info folders are missing
-RUN pip install -r requirements/production.in
+RUN atlas pull --repository="{{ ATLAS_REPOSITORY }}" --branch="{{ ATLAS_REVISION }}" {{ ATLAS_OPTIONS }} translations/credentials/credentials/conf/locale:credentials/conf/locale
+RUN python manage.py compilemessages
 
 # Setup minimal yml config file, which is required by production settings
 RUN echo "{}" > /openedx/config.yml
-ENV CREDENTIALS_CFG /openedx/config.yml
+# Below warning will occurr due to the variable name(have word "credentials" in it).
+# - SecretsUsedInArgOrEnv: Do not use ARG or ENV instructions for sensitive data (ENV "CREDENTIALS_CFG") (line 136)
+ENV CREDENTIALS_CFG=/openedx/config.yml
 
 {{ patch("credentials-dockerfile-pre-assets") }}
 
 # Collect static assets
 COPY --chown=app:app assets.py ./credentials/settings/assets.py
-ENV DJANGO_SETTINGS_MODULE credentials.settings.assets
+ENV DJANGO_SETTINGS_MODULE=credentials.settings.assets
 RUN python3 manage.py compilejsi18n
 RUN node_modules/.bin/webpack --config webpack.config.js
 RUN python3 manage.py collectstatic --noinput
 
-ENV DJANGO_SETTINGS_MODULE credentials.settings.tutor.production
+ENV DJANGO_SETTINGS_MODULE=credentials.settings.tutor.production
 
 # Create a data directory, which might be used (or not)
 RUN mkdir /openedx/data
@@ -174,15 +158,15 @@ RUN mkdir /openedx/data
 EXPOSE 8000
 
 ###### Final image with production cmd
-FROM production as final
+FROM production AS final
 
-CMD uwsgi \
-    --static-map /static=/openedx/credentials/credentials/assets \
-    --static-map /media=/openedx/credentials/credentials/media \
-    --http 0.0.0.0:8000 \
-    --thunder-lock \
-    --single-interpreter \
-    --enable-threads \
-    --processes=${UWSGI_WORKERS:-2} \
-    --buffer-size=8192 \
-    --wsgi-file credentials/wsgi.py
+CMD ["uwsgi", \
+    "--static-map", "/static=/openedx/credentials/credentials/assets", \
+    "--static-map", "/media=/openedx/credentials/credentials/media", \
+    "--http", "0.0.0.0:8000", \
+    "--thunder-lock", \
+    "--single-interpreter", \
+    "--enable-threads", \
+    "--processes=2", \ 
+    "--buffer-size=8192", \
+    "--wsgi-file", "credentials/wsgi.py"]

tutorcredentials/templates/credentials/tasks/credentials/init

@@ -5,21 +5,21 @@ echo "credentials service - ./manage.py migrate create_or_update_site"
 # for production
 ./manage.py create_or_update_site \
   --site-domain "{{ CREDENTIALS_HOST }}" \
-  --site-name "{{ CREDENTIALS_SITE_NAME }}" \
+  --site-name "{{ LMS_HOST }}" \
   --platform-name "{{ PLATFORM_NAME }}" \
-  --lms-url-root "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}" \
-  --catalog-api-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ DISCOVERY_HOST }}/api/v1/" \
-  --tos-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}/tos" \
-  --privacy-policy-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}/privacy-policy" \
-  --homepage-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}" \
+  --lms-url-root "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}" \
+  --catalog-api-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ DISCOVERY_HOST }}/api/v1/" \
+  --tos-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/tos" \
+  --privacy-policy-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}/privacy-policy" \
+  --homepage-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}" \
   --company-name "{{ PLATFORM_NAME }}" \
-  --certificate-help-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}{{ LMS_HOST }}" \
+  --certificate-help-url "{% if ENABLE_HTTPS %}https{% else %}http{% endif %}://{{ LMS_HOST }}" \
   --theme-name "{{ CREDENTIALS_THEME_NAME }}"
 
 # for development
 ./manage.py create_or_update_site \
-  --site-domain "{{ CREDENTIALS_HOST }}" \
-  --site-name "{{ CREDENTIALS_SITE_NAME }}" \
+  --site-domain "{{ CREDENTIALS_HOST }}:8150" \
+  --site-name "{{ LMS_HOST }}" \
   --platform-name "{{ PLATFORM_NAME }}" \
   --lms-url-root "http://{{ LMS_HOST }}:8000" \
   --catalog-api-url "http://{{ DISCOVERY_HOST }}:8381/api/v1/" \

tutorcredentials/templates/credentials/tasks/lms/init

@@ -8,7 +8,7 @@
 # Development client
 ./manage.py lms create_dot_application \
     --grant-type client-credentials \
-    --redirect-uris "http://{{ CREDENTIALS_HOST }}:8130/complete/edx-oauth2/" \
+    --redirect-uris "http://{{ CREDENTIALS_HOST }}:8150/complete/edx-oauth2/" \
     --client-id {{ CREDENTIALS_OAUTH2_KEY_DEV }} \
     --client-secret {{ CREDENTIALS_OAUTH2_SECRET }} \
     --scopes user_id \
@@ -18,7 +18,7 @@
     credentials
 ./manage.py lms create_dot_application \
     --grant-type authorization-code \
-    --redirect-uris "http://{{ CREDENTIALS_HOST }}:8130/complete/edx-oauth2/" \
+    --redirect-uris "http://{{ CREDENTIALS_HOST }}:8150/complete/edx-oauth2/" \
     --client-id {{ CREDENTIALS_OAUTH2_KEY_SSO_DEV }} \
     --client-secret {{ CREDENTIALS_OAUTH2_SECRET_SSO }} \
     --scopes user_id \
@@ -48,10 +48,3 @@
   --update \
   credentials-sso \
   credentials
-
-# Create commerce configuration
-#./manage.py lms configure_commerce
-
-# Enable order bistory microfrontend
-#site-configuration set ENABLE_ORDER_HISTORY_MICROFRONTEND true
-#(./manage.py lms waffle_switch --list | grep order_history.redirect_to_microfrontend) || ./manage.py lms waffle_switch --create order_history.redirect_to_microfrontend on

tutorcredentials/templates/credentials/tasks/mysql/sync_users

@@ -11,7 +11,7 @@ INSERT {{ CREDENTIALS_MYSQL_DATABASE }}.core_user (password, last_login, is_supe
                lms_user.is_staff, \
                lms_user.is_active, \
                lms_user.date_joined, \
-               CASE WHEN NOT ISNULL(lms_profile.name) THEN lms_profile.name ELSE lms_user.first_name + ' ' + lms_user.last_name END as full_name, \
+               CASE WHEN NOT ISNULL(lms_profile.name) THEN lms_profile.name ELSE CONCAT(lms_user.first_name, ' ', lms_user.last_name) END as full_name, \
                lms_user.id as lms_user_id \
      FROM      {{ OPENEDX_MYSQL_DATABASE }}.auth_user lms_user \
                LEFT JOIN {{ OPENEDX_MYSQL_DATABASE }}.auth_userprofile as lms_profile ON (lms_user.id = lms_profile.user_id) \