Skip to main content

Web fragments

Project description

PyPI Travis Codecov Documentation Supported Python versions License

Overview

The web fragments library provides a Python and Django implementation for managing fragments of web pages. In particular, this library refactors the fragment code from XBlock into a standalone implementation.

A Django view subclass called FragmentView is provided which supports three different ways of rendering a fragment into a page:

  • the fragment can be rendered as a standalone page at its own URL
  • the fragment can be rendered into another page directly from Django
  • the fragment can be returned as JSON so that it can be rendered client-side

The rationale behind this design can be found in OEP-12.

The intention is that a client-side implementation will be provided in a subsequent version. This should provide JavaScript code to request fragements over AJAX and then dynamically update the current page. This logic will be a refactoring of the current implementation in edx-platform for rendering XBlocks. It is also intended that this functionality will enhance the capabilities around dependency loading.

License

The code in this repository is licensed under the AGPL 3.0 unless otherwise noted.

Please see LICENSE.txt for details.

How To Contribute

Contributions are very welcome. Please read Contributing to edX for details.

Note: Even though these guidelines were written with edx-platform in mind, they should be followed for Open edX code in general.

Reporting Security Issues

Please do not report security issues in public. Please email security@edx.org.

Getting Help

Have a question about this repository, or about Open edX in general? Please refer to the Open edX guide to Getting Help.

We don’t maintain a detailed changelog. For details of changes, see the GitHub commit history.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for web-fragments, version 0.3.0
Filename, size File type Python version Upload date Hashes
Filename, size web_fragments-0.3.0-py2.py3-none-any.whl (16.1 kB) File type Wheel Python version py2.py3 Upload date Hashes View hashes
Filename, size web-fragments-0.3.0.tar.gz (13.4 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page