pok plugin for `Tutor <https://docs.tutor.edly.io>`__
#####################################################
Tutor plugin to integrate POK certificates into Open edX
About POK
*********
`POK <https://pok.tech>`_ revolutionizes credential management with powerful analytics and branding capabilities.
**Smart Credentials**
Track the real impact of your credentials with real-time metrics. See how many are viewed, shared on LinkedIn, or downloaded. Understand how they create career opportunities and improve your strategy based on concrete data.
**Brand Customization**
Customize every aspect of your credential experience - from pages to emails - with your logo, colors, and messages. Support for AI-powered automatic translations ensures a consistent brand experience globally.
**Actionable Insights**
Capture leads from your branded pages, access valuable insights on credential interactions, and download reports with one click. Our learning paths and analytics dashboards help improve user retention and drive growth.
Installation
************
.. code-block:: bash
pip install git+https://github.com/aulasneo/tutor-contrib-pok
Usage
*****
.. code-block:: bash
tutor plugins enable pok
After enabling the plugin, you must activate POK certificates by enabling the ``module_pok.enable`` waffle flag. By default, POK certificates are disabled until this flag is turned on. You can also set course or organization-specific overrides in the waffle flags configuration for more granular control.
Configuration
*************
The following settings can be configured in your Tutor environment:
- ``POK_API_KEY``: (Required) The API key for authenticating with the POK service. This key is used to validate requests between your Open edX instance and POK.
- ``POK_TEMPLATE_ID``: (Optional) The default template ID to use for certificates when no course-specific template is specified. If not set, you'll need to configure templates for each course individually.
Example configuration in ``config.yml``:
.. code-block:: yaml
POK_API_KEY: "your-api-key-here"
POK_TEMPLATE_ID: "default-template-id" # Optional
Django Admin Configuration
**************************
After installation, two new sections will be available in the Django admin interface under "POK":
1. **Certificate Templates**
- Map POK templates to specific courses
- Fields:
- **Course**: Select the course for this template
- **Template ID**: The POK template ID to use
- **Emission Type** (Optional):
- 'POK' for standard PDF certificates (default)
- 'Blockchain' for NFT certificates
- **Page ID** (Optional): Custom page ID if defined in your POK site
2. **POK Certificates**
- View and manage issued POK certificates
To access these settings:
1. Log in to the Django admin interface
2. Navigate to the "POK" section
3. Click on "Certificate templates" to manage course-specific templates
4. Click on "POK certificates" to view issued certificates
Version Management
******************
This project uses `bump2version <https://github.com/c4urself/bump2version>`_ to manage version numbers. The version is maintained in ``tutorpok/__about__.py``.
To install bump2version:
.. code-block:: bash
pip install bump2version
To bump the version:
- For bug fixes (0.0.x): ``bump2version patch``
- For new features (0.x.0): ``bump2version minor``
- For breaking changes (x.0.0): ``bump2version major``
Raw data
{
"_id": null,
"home_page": null,
"name": "tutor-contrib-pok",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Aulasneo",
"author_email": "andres@aulasneo.com",
"download_url": "https://files.pythonhosted.org/packages/38/a9/cd72fcee3255b38c226cac52bde501b2d256b0d3a47f1bfd36ff2a838dc7/tutor_contrib_pok-19.0.1.tar.gz",
"platform": null,
"description": "pok plugin for `Tutor <https://docs.tutor.edly.io>`__\n#####################################################\n\nTutor plugin to integrate POK certificates into Open edX\n\nAbout POK\n*********\n\n`POK <https://pok.tech>`_ revolutionizes credential management with powerful analytics and branding capabilities.\n\n**Smart Credentials**\n\nTrack the real impact of your credentials with real-time metrics. See how many are viewed, shared on LinkedIn, or downloaded. Understand how they create career opportunities and improve your strategy based on concrete data.\n\n**Brand Customization**\n\nCustomize every aspect of your credential experience - from pages to emails - with your logo, colors, and messages. Support for AI-powered automatic translations ensures a consistent brand experience globally.\n\n**Actionable Insights**\n\nCapture leads from your branded pages, access valuable insights on credential interactions, and download reports with one click. Our learning paths and analytics dashboards help improve user retention and drive growth.\n\nInstallation\n************\n\n.. code-block:: bash\n\n pip install git+https://github.com/aulasneo/tutor-contrib-pok\n\nUsage\n*****\n\n.. code-block:: bash\n\n tutor plugins enable pok\n\nAfter enabling the plugin, you must activate POK certificates by enabling the ``module_pok.enable`` waffle flag. By default, POK certificates are disabled until this flag is turned on. You can also set course or organization-specific overrides in the waffle flags configuration for more granular control.\n\nConfiguration\n*************\n\nThe following settings can be configured in your Tutor environment:\n\n- ``POK_API_KEY``: (Required) The API key for authenticating with the POK service. This key is used to validate requests between your Open edX instance and POK.\n- ``POK_TEMPLATE_ID``: (Optional) The default template ID to use for certificates when no course-specific template is specified. If not set, you'll need to configure templates for each course individually.\n\nExample configuration in ``config.yml``:\n\n.. code-block:: yaml\n\n POK_API_KEY: \"your-api-key-here\"\n POK_TEMPLATE_ID: \"default-template-id\" # Optional\n\nDjango Admin Configuration\n**************************\n\nAfter installation, two new sections will be available in the Django admin interface under \"POK\":\n\n1. **Certificate Templates**\n\n - Map POK templates to specific courses\n - Fields:\n\n - **Course**: Select the course for this template\n - **Template ID**: The POK template ID to use\n - **Emission Type** (Optional):\n\n - 'POK' for standard PDF certificates (default)\n - 'Blockchain' for NFT certificates\n\n - **Page ID** (Optional): Custom page ID if defined in your POK site\n\n2. **POK Certificates**\n\n - View and manage issued POK certificates\n\nTo access these settings:\n\n1. Log in to the Django admin interface\n2. Navigate to the \"POK\" section\n3. Click on \"Certificate templates\" to manage course-specific templates\n4. Click on \"POK certificates\" to view issued certificates\n\nVersion Management\n******************\n\nThis project uses `bump2version <https://github.com/c4urself/bump2version>`_ to manage version numbers. The version is maintained in ``tutorpok/__about__.py``.\n\nTo install bump2version:\n\n.. code-block:: bash\n\n pip install bump2version\n\nTo bump the version:\n\n- For bug fixes (0.0.x): ``bump2version patch``\n- For new features (0.x.0): ``bump2version minor``\n- For breaking changes (x.0.0): ``bump2version major``",
"bugtrack_url": null,
"license": "GNU Affero General Public License v3",
"summary": "Tutor plugin to integrate POK certificates into Open edX",
"version": "19.0.1",
"project_urls": {
"Documentation": "https://github.com/aulasneo/tutor-contrib-pok#readme",
"Issues": "https://github.com/aulasneo/tutor-contrib-pok/issues",
"Source": "https://github.com/aulasneo/tutor-contrib-pok"
},
"split_keywords": [],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "867598f9e4048707ec0995122c14940a8bce93efecb85b53ddcabe0fadddac71",
"md5": "b1c9c9a94e1b7ce0bea05f266c952350",
"sha256": "aead981d0d79dd9fb81817409b86ec49eb1b8df611571d051ca6ee95b742d38c"
},
"downloads": -1,
"filename": "tutor_contrib_pok-19.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b1c9c9a94e1b7ce0bea05f266c952350",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 19325,
"upload_time": "2025-07-18T11:23:26",
"upload_time_iso_8601": "2025-07-18T11:23:26.761808Z",
"url": "https://files.pythonhosted.org/packages/86/75/98f9e4048707ec0995122c14940a8bce93efecb85b53ddcabe0fadddac71/tutor_contrib_pok-19.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "38a9cd72fcee3255b38c226cac52bde501b2d256b0d3a47f1bfd36ff2a838dc7",
"md5": "8fe70882c0bedd74c6cd4fd691e5be6f",
"sha256": "c1fd9cf01a38f36425409294a64c2f296c385400ff2781ba2cc426518c35f546"
},
"downloads": -1,
"filename": "tutor_contrib_pok-19.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8fe70882c0bedd74c6cd4fd691e5be6f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 17448,
"upload_time": "2025-07-18T11:23:27",
"upload_time_iso_8601": "2025-07-18T11:23:27.820170Z",
"url": "https://files.pythonhosted.org/packages/38/a9/cd72fcee3255b38c226cac52bde501b2d256b0d3a47f1bfd36ff2a838dc7/tutor_contrib_pok-19.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-07-18 11:23:27",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "aulasneo",
"github_project": "tutor-contrib-pok#readme",
"github_not_found": true,
"lcname": "tutor-contrib-pok"
}
JSON
