|PyPI version| |Build Status|
OLX Utilities
=============
A set of tools to facilitate courseware development using the `Open
Learning
XML <http://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/>`__
(OLX) format.
OLX is sometimes tediously repetitive, and this package enables
courseware authors to apply the
`DRY <https://en.wikipedia.org/wiki/Don%27t_repeat_yourself>`__
principle when writing OLX content. It allows you to create templates
(using `Mako <http://www.makotemplates.org/>`__), which in turn enable
you to
- define OLX fragments only once, to reuse them as often as you want
(this comes in very handy in using the `hastexo
XBlock <https://github.com/hastexo/hastexo-xblock>`__),
- write courseware content in
`Markdown <https://en.wikipedia.org/wiki/Markdown>`__,
- do anything else you would like to do using your own plugins.
Install
-------
Install the ``olx-utils`` package from PyPI:
.. code:: bash
pip install olx-utils
Apply templates to a course
---------------------------
In order to create a new course run named ``newrun``, starting on May 1,
2017 and ending on October 31, 2017, simply change into your courseware
checkout and run:
.. code:: bash
olx new-run -b newrun 2019-01-01 2019-12-31
The ``-b`` option causes your rendered OLX to be added to a new Git
branch named ``run/newrun``, which you can then import into your Open
edX content store.
You can also invoke ``olx new-run`` as ``new_run.py``. However, this
is deprecated and its use is discouraged. ``new_run.py`` will go
away in a future release.
License
-------
This package is licensed under the `GNU Affero
GPL <https://tldrlegal.com/l/agpl3>`__; see
`LICENSE <https://www.gnu.org/licenses/agpl-3.0.txt>`__
for details.
.. |PyPI version| image:: https://img.shields.io/pypi/v/olx-utils.svg
:target: https://pypi.python.org/pypi/olx-utils
.. |Build Status| image:: https://github.com/hastexo/hastexo-xblock/workflows/Python%20package/badge.svg
:target: https://github.com/hastexo/hastexo-xblock/actions?query=workflow%3A%22Python+package%22
Raw data
{
"_id": null,
"home_page": "https://github.com/hastexo/olx-utils",
"name": "olx-utils",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "hastexo",
"author_email": "pypi@hastexo.com",
"download_url": "https://files.pythonhosted.org/packages/14/04/4ecc5c04cd98338b9c69c098e1f8c1e0cec92060296490f2cd18350b9f42/olx-utils-0.4.0.tar.gz",
"platform": null,
"description": "|PyPI version| |Build Status|\n\nOLX Utilities\n=============\n\nA set of tools to facilitate courseware development using the `Open\nLearning\nXML <http://edx.readthedocs.io/projects/edx-open-learning-xml/en/latest/>`__\n(OLX) format.\n\nOLX is sometimes tediously repetitive, and this package enables\ncourseware authors to apply the\n`DRY <https://en.wikipedia.org/wiki/Don%27t_repeat_yourself>`__\nprinciple when writing OLX content. It allows you to create templates\n(using `Mako <http://www.makotemplates.org/>`__), which in turn enable\nyou to\n\n- define OLX fragments only once, to reuse them as often as you want\n (this comes in very handy in using the `hastexo\n XBlock <https://github.com/hastexo/hastexo-xblock>`__),\n- write courseware content in\n `Markdown <https://en.wikipedia.org/wiki/Markdown>`__,\n- do anything else you would like to do using your own plugins.\n\nInstall\n-------\n\nInstall the ``olx-utils`` package from PyPI:\n\n.. code:: bash\n\n pip install olx-utils\n\nApply templates to a course\n---------------------------\n\nIn order to create a new course run named ``newrun``, starting on May 1,\n2017 and ending on October 31, 2017, simply change into your courseware\ncheckout and run:\n\n.. code:: bash\n\n olx new-run -b newrun 2019-01-01 2019-12-31\n\nThe ``-b`` option causes your rendered OLX to be added to a new Git\nbranch named ``run/newrun``, which you can then import into your Open\nedX content store.\n\n You can also invoke ``olx new-run`` as ``new_run.py``. However, this\n is deprecated and its use is discouraged. ``new_run.py`` will go\n away in a future release.\n\nLicense\n-------\n\nThis package is licensed under the `GNU Affero\nGPL <https://tldrlegal.com/l/agpl3>`__; see\n`LICENSE <https://www.gnu.org/licenses/agpl-3.0.txt>`__\nfor details.\n\n.. |PyPI version| image:: https://img.shields.io/pypi/v/olx-utils.svg\n :target: https://pypi.python.org/pypi/olx-utils\n.. |Build Status| image:: https://github.com/hastexo/hastexo-xblock/workflows/Python%20package/badge.svg\n :target: https://github.com/hastexo/hastexo-xblock/actions?query=workflow%3A%22Python+package%22\n\n\n",
"bugtrack_url": null,
"license": "AGPL-3.0",
"summary": "Utilities for edX OLX courses",
"version": "0.4.0",
"project_urls": {
"Homepage": "https://github.com/hastexo/olx-utils"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "14044ecc5c04cd98338b9c69c098e1f8c1e0cec92060296490f2cd18350b9f42",
"md5": "bdcb8ba3898e6500ace41f226501fb45",
"sha256": "e81b3b627b26bae1eec14d9dcd7c7b387883a37201e1dc7a1602ee38d92e3336"
},
"downloads": -1,
"filename": "olx-utils-0.4.0.tar.gz",
"has_sig": false,
"md5_digest": "bdcb8ba3898e6500ace41f226501fb45",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 509913,
"upload_time": "2024-01-18T11:43:49",
"upload_time_iso_8601": "2024-01-18T11:43:49.637526Z",
"url": "https://files.pythonhosted.org/packages/14/04/4ecc5c04cd98338b9c69c098e1f8c1e0cec92060296490f2cd18350b9f42/olx-utils-0.4.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-18 11:43:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hastexo",
"github_project": "olx-utils",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "olx-utils"
}
JSON
