staubina
(AJ St. Aubin)
June 29, 2021, 7:19pm
1
We are planning to archive the edx-certificates repo per OEP-14 and OEP-21 . This repository is no longer in use for edx.org and has remained mostly unchanged for a number of years.
This will remove support for the manual generation of PDF certificates.
Please see this DEPR ticket for more details.
https://openedx.atlassian.net/browse/DEPR-160
If there is any interest in ownership transfer of this repository please refer to this section of OEP-14: OEP-14: Archiving edX GitHub Repositories — Open edX Proposals 1.0 documentation , and contact us through this thread.
fghaas
(Florian Haas)
June 30, 2021, 7:31am
2
@mrtmm has recently landed a patch restoring Badgr/OpenBadges functionality.
edx:master
← mrtmm:badgr-integration-updates
opened 08:43AM - 30 Mar 21 UTC
## Description
The Badgr integration at its current state is broken and it wo… uld be great if we could fix it. This PR holds commits for that purpose.
For a while now, it is not possible to create a badge on the Badgr side with a `slug` that we provide. Instead a `slug` (Badgr API v1) or an `entityId` (Badgr API v2) is created for each badge on the Badgr side and we will need to know about it in order to check if a certain badge exists or to create assertions for one.
A proposed fix for this is to cherry-pick a commit (from 3309aab2a2eb00d28c5ca3d3145c8dddb15e6159) to introduce a new field to the BadgeClass model: `badgr_server_slug` that will store this value for us.
However, I've modified that commit by making this field optional since Badgr is not the only backend that can be used for badging.
The long-lived access tokens are no longer supported by Badgr. Instead, we'll need to implement the flow of creating and refreshing the access tokens that are valid for 24h. This PR proposes the changes to implement this flow. With this change the necessary values for creating tokens should be configured in `lms.yml`. The tokens will be then created or refreshed on the go as needed and stored in cache.
The Badgr API v1 will likely reach end-of-life in Q4 2021 so we'd probably want to make the switch to API v2 as well.
## Testing instructions
Prerequisites:
An Issuer App is needed, either registered at https://badgr.org/app-developers/#issuer-apps or in your own instance of the Badgr Server.
Configuration examples:
in `studio.yml` and `lms.yml`:
```
FEATURES:
ENABLE_OPENBADGES: true
```
in `lms.yml`:
```
BADGR_USERNAME = "example@example.com"
BADGR_PASSWORD = "password"
BADGR_TOKENS_CACHE_KEY = "secret-cache-key"
BADGR_BASE_URL = "http://localhost:8005"
BADGR_ISSUER_SLUG = "issuer-slug"
```
Make sure your Issuer App is configured properly, you can test creating and refreshing tokens as noted in https://api.badgr.io/docs/v2/ :
```
curl -X POST '$BADGR_BASE_URL/o/token' -d "username=$BADGR_USERNAME&password=$BADGR_PASSWORD"
```
```
curl -X POST '$BADGR_BASE_URL/o/token' -d "grant_type=refresh_token&refresh_token=<refresh_token>"
```
## Documentation
PR for updating the documentation to match these changes: https://github.com/edx/edx-documentation/pull/1927
Can you please elaborate on the impact that the removal of edx-certificates will have on that functionality, if any?
staubina
(AJ St. Aubin)
June 30, 2021, 1:15pm
3
@fghaas I do not believe that there is any connection between that feature and this repository.
edx-certificates is used only for manual PDF certificate generation and has not been running in production for edX in 2+ years. It also has no known integrations into edx-platform code base.
1 Like
dave
(Dave Ormsbee)
January 14, 2022, 4:32pm
4
The edx-certificates
repo has been moved from the openedx
github org to the openedx-unsupported
org, and archived: