https://github.com/openedx/web-fragments

Provides the ability to render fragments of web pages
https://github.com/openedx/web-fragments

Last synced: about 9 hours ago
JSON representation

Provides the ability to render fragments of web pages

• Host: GitHub
• URL: https://github.com/openedx/web-fragments
• Owner: openedx
• License: apache-2.0
• Created: 2016-12-08T15:24:36.000Z (about 8 years ago)
• Default Branch: master
• Last Pushed: 2024-12-13T05:06:19.000Z (14 days ago)
• Last Synced: 2024-12-19T07:06:20.314Z (8 days ago)
• Language: Python
• Homepage:
• Size: 271 KB
• Stars: 9
• Watchers: 79
• Forks: 8
• Open Issues: 10
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE.txt
  • Authors: AUTHORS

Awesome Lists containing this project

README

        
web-fragments

=============

.. image:: https://img.shields.io/pypi/v/web-fragments.svg

    :target: https://pypi.python.org/pypi/web-fragments/

    :alt: PyPI

.. image:: https://github.com/openedx/web-fragments/workflows/Python%20CI/badge.svg?branch=master

    :target: https://github.com/openedx/web-fragments/actions?query=workflow%3A%22Python+CI%22

    :alt: CI

.. image:: http://codecov.io/github/edx/web-fragments/coverage.svg?branch=master

    :target: http://codecov.io/github/edx/web-fragments?branch=master

    :alt: Codecov

.. image:: http://web-fragments.readthedocs.io/en/latest/?badge=latest

    :target: http://web-fragments.readthedocs.io/en/latest/

    :alt: Documentation

.. image:: https://img.shields.io/pypi/pyversions/web-fragments.svg

    :target: https://pypi.python.org/pypi/web-fragments/

    :alt: Supported Python versions

.. image:: https://img.shields.io/github/license/edx/web-fragments.svg

    :target: https://github.com/openedx/web-fragments/blob/master/LICENSE.txt

    :alt: 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`_.

.. _OEP-12: https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0012-arch-fragment-views.html

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.

.. Documentation

.. -------------

..

.. The full documentation is at https://web-fragments.readthedocs.org.

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 `the Open edX Contributing Guide`_ for details.

.. _the Open edX Contributing Guide: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md

Reporting Security Issues

-------------------------

Please do not report security issues in public. Please email [email protected].

Getting Help

------------

Have a question about this repository, or about Open edX in general?  Please

refer to the Open edX guide to `Getting Help`_.

.. _Getting Help: https://open.edx.org/getting-help