Digital badge management for issuers, earners, and consumers
Edubadges server is the Python/Django API backend for issuing edubadges. Edubadges are digital credentials that use the Open Badges standard. In addition to a powerful issuer API and browser-based user interface for issuing, Edubadges offers integrated badge management and sharing for badge earners.
See also edubadges-ui, the Svelte frontend that serves as the user interface for this project.
This software is based on the Badgr software from Concentric Sky.
A badge is a digital piece of evidence with which a student demonstrates that he or she has mastered certain skills or knowledge. In the context of lifelong development, students and employees are increasingly being educated or gaining experience at various institutions, both in their own country and abroad. Badges are a great instrument to make acquired knowledge and skills visible and 'portable'.
Institutions are looking into the possibilities of using digital certification for (partial) results obtained by their students. Since 2018 SURF works with various educational institutions to build a digital infrastructure with the purpose to be able to issue such digital certificates, or 'edubadges'.
An increasing number of students have − whether previously or elsewhere − acquired skills and knowledge relevant to their study, and they wish to receive recognition or exemption for this in their study programme. A number of institutions are looking into the possibility of providing courses in accredited units that are smaller than a diploma (micro-credentials). Digital badges are the tools to achieve this. As these badges are issued in an educational context, they are called 'edubadges'. Read more on edubadges.nl.
Badgr was developed by Concentric Sky, starting in 2015 to serve as an open source reference implementation of the Open Badges Specification. It provides functionality to issue portable, verifiable Open Badges as well as to allow users to manage badges they have been awarded by any issuer that uses this open data standard. Since 2015, Badgr has grown to be used by hundreds of educational institutions and other people and organizations worldwide. See Project Homepage for more details about contributing to and integrating with Badgr.
Prerequisites:
- git
- python 3.8
- mysql
- cairo (SVG utility)
- memcached
- OS X: XCode Command line tools
- Ubuntu 12.04 (install packages with apt-get): git, git-core, python-virtualenv, gcc, python-pip, python-devel, libjpeg-turbo, libjpeg-turbo-devel, zlib-devel, mariadb-devel, openldap-devel, cyrus-sasl-devel, swig, libxslt-devel, automake, autoconf, libtool, libffi-devel
- CentOS 7.x (install packages with yum): git, git-core, python-virtualenv, gcc, python-pip, python-devel, libjpeg-turbo, libjpeg-turbo-devel, zlib-devel, mariadb-devel, openldap-devel, cyrus-sasl-devel, swig, libxslt-devel, automake, autoconf, libtool, libffi-devel
Note: some of these packages would introduce additional security considerations if left installed on a server used in production.
mkdir edubadges && cd edubadgespython3.8 -m venv .venvsource .venv/bin/activateActivate the environment (each time you start a session working with the code)
Obtain source code and clone into code directory
git clone https://github.com/edubadges/edubadges-server.gitcd edubadges-servergit submodule update --init
DROP DATABASE IF EXISTS badgr;
CREATE DATABASE badgr CHARACTER SET utf8 DEFAULT COLLATE utf8_general_ci;
mysql_tzinfo_to_sql /usr/share/zoneinfo | mysql -u root mysql
from within edubadges-server directory
pip install -r requirements.txt
if on a mac mysqlclient does not build, try:
LDFLAGS=-L/usr/local/opt/openssl/lib pip install mysqlclient
If for some reason the library files for mysql are no longer there due to an upgrade
pip install --upgrade --force-reinstall --no-cache-dir mysqlclient
If you use an IDE, you'll need to add the environment variables from env_vars.sh.example to a run configuration
If you login to http://localhost:8000/staff/superuser then you'll have to provide a TOTP token. Generate one with:
./manage.py addstatictoken superuser
cp env_vars.sh.example env_vars.sh- Edit the env_vars.sh file and insert local credentials for DATABASES and email, then run the following from within the
edubadges-serverdirectory after sourcing the env_vars.sh:
source env.vars.sh
./manage.py migrate- set up database tables
./manage.py seed -c- truncate tables and refill with seed data./manage.py seed- fill tables with seed data if objects don't exist yet
./manage.py runserver
./manage.py show_urls
/staff/superlogin- You can log in on the staff dashboard with your superuser credentials (if you ran the seeds these will be username: superuser, password: secret).
/docs
Set these values in your settings_local.py file to configure the application to your specific needs. Required options are listed in bold.
HELP_EMAIL(Required)- An email address for your support staff.
GOOGLE_ANALYTICS_ID- Google Analytics code will be inserted into your pages if this is set to your account tracking code, e.g. 'UA-3929083373-2'. See https://support.google.com/analytics/answer/1008080
PINGDOM_MONITORING_ID- If you use Pingdom to monitor site performance, including this setting will embed Pingdom tracking script into the header.
OPEN_FOR_SIGNUP = True- This defaults to True, but allows you to turn off signup if you would like to use Badgr for only single-account use or to manually create all users in
/staff.
- This defaults to True, but allows you to turn off signup if you would like to use Badgr for only single-account use or to manually create all users in
PAGINATION_SECRET_KEY- Key used for symmetrical encryption of pagination cursors. If not defined, encryption is disabled. Must be 32 byte, base64-encoded random string. For example: python -c "from cryptography.fernet import Fernet; print(Fernet.generate_key())"
http://127.0.0.1:8000/api/schema/swagger-ui/ https://api-test.edubadges.nl/api/schema/swagger-ui