help-tokens

library4.0.0pypypi✓ verified 79d ago

Django app for linking to help pages with short tokens. Current version 4.0.0 (released Feb 2024). Maintained as part of the Open edX ecosystem; irregular release cadence.

web-framework database

pip install help-tokens

github ↗package ↗

INSTALL

IMPORT

SIG · HELP-TOKENS

help-tokens

web-frameworkpythonv4.0.0

harness data pending

Install & Compatibility

Where this runs

No compatibility data collected yet for this library.

Code

Verified usage

Verified import paths — ran on the pinned version, not inferred.

context_processor

✓ from help_tokens import context_processor

✗ from help_tokens.middleware import HelpTokenMiddleware

core

✓ from help_tokens import core

Add help_tokens to INSTALLED_APPS, include the middleware, and define HELP_TOKENS mapping.

# settings.py INSTALLED_APPS = [ ... 'help_tokens', ] MIDDLEWARE = [ ... 'help_tokens.middleware.HelpTokenMiddleware', ] HELP_TOKENS_BASE_URL = os.environ.get('HELP_TOKENS_BASE_URL', 'http://example.com/help/') HELP_TOKENS = { 'student-dashboard': 'student/dashboard/', }

Debug

Known issues

breakingv4.0.0 dropped support for Python 3.11. Python 3.11 users must pin to <4.0.0.

fix

Use Python 3.12+ or install help-tokens==3.2.0.

affects: >=4.0.0

breakingv2.0.0 dropped Python 3.5 support. Ensure your Python version is >=3.6.

fix

Upgrade Python to 3.6+.

affects: >=2.0.0

deprecatedThe import 'from help_tokens import get_help_url' was deprecated in v2.0.0 and removed in v4.0.0.

fix

Use 'from help_tokens.core import get_help_url'.

affects: >=4.0.0

gotchaMiddleware must be placed after SessionMiddleware and AuthenticationMiddleware to access user context.

fix

Ensure middleware ordering: SessionMiddleware, AuthenticationMiddleware, then HelpTokenMiddleware.

affects: all

Upgrade

Version history

4.0.0latest on PyPI · released Mar 26, 2026

Audit

Dependencies

No dependency data recorded yet.

Agent activity

4 hits · last 30 days

node

Resources

githubhttps://github.com/openedx/help-tokens ↗

packagehttps://pypi.org/project/help-tokens/ ↗