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 security@openedx.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`_.
.. _Getting Help: https://open.edx.org/getting-help
We don't maintain a detailed changelog. For details of changes, see the
`GitHub commit history`_.
.. _GitHub commit history: https://github.com/openedx/web-fragments/commits/master
Raw data
{
"_id": null,
"home_page": "https://github.com/openedx/web-fragments",
"name": "web-fragments",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Django edx",
"author": "edX",
"author_email": "oscm@edx.org",
"download_url": "https://files.pythonhosted.org/packages/82/49/d30503bd1ab204b72b25e0a530f1cfe76c62d865d0cf17d5737f7d068c38/web-fragments-2.2.0.tar.gz",
"platform": null,
"description": "web-fragments\n=============\n\n.. image:: https://img.shields.io/pypi/v/web-fragments.svg\n :target: https://pypi.python.org/pypi/web-fragments/\n :alt: PyPI\n\n.. image:: https://github.com/openedx/web-fragments/workflows/Python%20CI/badge.svg?branch=master\n :target: https://github.com/openedx/web-fragments/actions?query=workflow%3A%22Python+CI%22\n :alt: CI\n\n.. image:: http://codecov.io/github/edx/web-fragments/coverage.svg?branch=master\n :target: http://codecov.io/github/edx/web-fragments?branch=master\n :alt: Codecov\n\n.. image:: http://web-fragments.readthedocs.io/en/latest/?badge=latest\n :target: http://web-fragments.readthedocs.io/en/latest/\n :alt: Documentation\n\n.. image:: https://img.shields.io/pypi/pyversions/web-fragments.svg\n :target: https://pypi.python.org/pypi/web-fragments/\n :alt: Supported Python versions\n\n.. image:: https://img.shields.io/github/license/edx/web-fragments.svg\n :target: https://github.com/openedx/web-fragments/blob/master/LICENSE.txt\n :alt: License\n\nOverview\n--------\n\nThe web fragments library provides a Python and Django implementation for\nmanaging fragments of web pages. In particular, this library refactors the\nfragment code from XBlock into a standalone implementation.\n\nA Django view subclass called FragmentView is provided which supports three\ndifferent ways of rendering a fragment into a page:\n\n* the fragment can be rendered as a standalone page at its own URL\n* the fragment can be rendered into another page directly from Django\n* the fragment can be returned as JSON so that it can be rendered client-side\n\nThe rationale behind this design can be found in `OEP-12`_.\n\n.. _OEP-12: https://open-edx-proposals.readthedocs.io/en/latest/architectural-decisions/oep-0012-arch-fragment-views.html\n\nThe intention is that a client-side implementation will be provided in a\nsubsequent version. This should provide JavaScript code to request fragements\nover AJAX and then dynamically update the current page. This logic will be a\nrefactoring of the current implementation in edx-platform for rendering XBlocks.\nIt is also intended that this functionality will enhance the capabilities\naround dependency loading.\n\n.. Documentation\n.. -------------\n..\n.. The full documentation is at https://web-fragments.readthedocs.org.\n\nLicense\n-------\n\nThe code in this repository is licensed under the AGPL 3.0 unless otherwise\nnoted.\n\nPlease see ``LICENSE.txt`` for details.\n\nHow To Contribute\n-----------------\n\nContributions are very welcome. Please read `the Open edX Contributing Guide`_ for details.\n\n.. _the Open edX Contributing Guide: https://github.com/openedx/.github/blob/master/CONTRIBUTING.md\n\nReporting Security Issues\n-------------------------\n\nPlease do not report security issues in public. Please email security@openedx.org.\n\nGetting Help\n------------\n\nHave a question about this repository, or about Open edX in general? Please\nrefer to the Open edX guide to `Getting Help`_.\n\n.. _Getting Help: https://open.edx.org/getting-help\n\n\nWe don't maintain a detailed changelog. For details of changes, see the\n`GitHub commit history`_.\n\n.. _GitHub commit history: https://github.com/openedx/web-fragments/commits/master\n",
"bugtrack_url": null,
"license": "AGPL 3.0",
"summary": "Web fragments",
"version": "2.2.0",
"project_urls": {
"Homepage": "https://github.com/openedx/web-fragments"
},
"split_keywords": [
"django",
"edx"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "396200a80bff0ca118a5e487326e626252b2362d2bae2e9e77b9e7de02e83ed2",
"md5": "7c9ae0b79dc0be78efe2cb0ee8d9aa80",
"sha256": "615a9b8e7981f21d60a00a41d4eebb1c48ad856864d5e229a0a004342e6a244f"
},
"downloads": -1,
"filename": "web_fragments-2.2.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c9ae0b79dc0be78efe2cb0ee8d9aa80",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 15485,
"upload_time": "2024-04-02T19:14:00",
"upload_time_iso_8601": "2024-04-02T19:14:00.597954Z",
"url": "https://files.pythonhosted.org/packages/39/62/00a80bff0ca118a5e487326e626252b2362d2bae2e9e77b9e7de02e83ed2/web_fragments-2.2.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "8249d30503bd1ab204b72b25e0a530f1cfe76c62d865d0cf17d5737f7d068c38",
"md5": "2506f6a07297e2d1b47590aee51f33fb",
"sha256": "9a6a448c5a6dcab13c3d0f3e89db479783445d8b4af5bdc360074320f2b90ba3"
},
"downloads": -1,
"filename": "web-fragments-2.2.0.tar.gz",
"has_sig": false,
"md5_digest": "2506f6a07297e2d1b47590aee51f33fb",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 15069,
"upload_time": "2024-04-02T19:14:02",
"upload_time_iso_8601": "2024-04-02T19:14:02.333895Z",
"url": "https://files.pythonhosted.org/packages/82/49/d30503bd1ab204b72b25e0a530f1cfe76c62d865d0cf17d5737f7d068c38/web-fragments-2.2.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-02 19:14:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "openedx",
"github_project": "web-fragments",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"tox": true,
"lcname": "web-fragments"
}
JSON
