{ "info": { "author": "Jaakko Kantoj\u00e4rvi", "author_email": "jaakko.kantojarvi@aalto.fi", "bugtrack_url": null, "classifiers": [ "Development Status :: 4 - Beta", "Intended Audience :: Developers", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3 :: Only", "Topic :: Software Development :: Build Tools", "Topic :: Software Development :: Libraries :: Python Modules" ], "description": "Roman\n=====\n\n|build status| |download release|\n\nRoman is course material builder for A+ and other learning management systems.\nRoman uses docker_ to run different build steps.\nCourse building steps are configure in :code:`course.yml`, which is read by roman.\n\n.. _docker: https://www.docker.com/\n\n**Roman is in experimental development state**\n\nCheck out :code:`Ariel`.\nIt is an extension to sphinx build process that is used to build RST course material to HTML and YAML files.\nIt can simple be used by adding :code:`apluslms/ariel` to build steps.\n\nCourse configuration\n--------------------\n\nRoman reads configuration file :code:`course.yml`, :code:`course.yaml` or :code:`course.json` and then\nruns course build steps defined in :code:`steps` list.\nSteps can be strings describing docker image or objects containing at least :code:`img`.\nHere is small example:\n\n.. code-block:: yaml\n\n # course.yml\n ---\n version: 2\n theme: aplus\n\n steps:\n - hello-world\n - img: apluslms/compile-rst\n cmd: make touchrst html\n mnt: /compile\n env:\n STATIC_CONTENT_HOST: \"http://localhost:8080/static/default\"\n\n\nInstallation\n------------\n\nYou can use prebuild binaries with graphical user inteface from `releases page`_.\nAlternatively, you can install cli version via pip :code:`pip install apluslms-roman` (will add :code:`roman` command).\n\n.. _releases page: https://github.com/apluslms/roman/releases\n\n\nList of graphical user inteface binaries\n^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^\n\n* :code:`*-linux.AppImage` is an AppImage_ package of Roman.\n Download, mark file executable and run it.\n Requires FUSE_ (installed on typical linux desktop).\n* :code:`*-linux.zip` contains a single-file executable.\n Download, extract, run :code:`roman`.\n Requires that files in :code:`/tmp/` can be executed.\n* :code:`*-mac.dmg` contains *Roman.app* in a disk image.\n Download, open, drag *Roman.app* to e.g. *Applications*, run.\n **Note**: On the first time you need to right or control-click the app, select *open* in the menu and finally *open* in the dialog.\n* :code:`*-mac.zip` contains *Roman.app* in a zip.\n Same prosess as with above version.\n\nIf you are not sure what file to use, then use the first one for your operating system.\n\n.. _AppImage: https://appimage.org/\n.. _FUSE: https://en.wikipedia.org/wiki/Filesystem_in_Userspace\n\n\n.. badges: http://shields.io/\n\n.. |build status| image:: https://img.shields.io/travis/apluslms/roman.svg\n :target: https://travis-ci.org/apluslms/roman\n\n.. |download release| image:: https://img.shields.io/github/release/apluslms/roman.svg\n :target: https://github.com/apluslms/roman/releases\n\n\n", "description_content_type": null, "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/apluslms/roman", "keywords": "apluslms material", "license": "MIT", "maintainer": "", "maintainer_email": "", "name": "apluslms-roman", "package_url": "https://pypi.org/project/apluslms-roman/", "platform": "", "project_url": "https://pypi.org/project/apluslms-roman/", "project_urls": { "Homepage": "https://github.com/apluslms/roman" }, "release_url": "https://pypi.org/project/apluslms-roman/0.2.1rc4/", "requires_dist": [ "PyYaml (>=3.12)", "Docker (>=3.0.0)" ], "requires_python": "", "summary": "Course material builder for online learning systems", "version": "0.2.1rc4" }, "last_serial": 4923143, "releases": { "0.2.1rc4": [ { "comment_text": "", "digests": { "md5": "2caf347090f6faa688bd2368f2c9f79a", "sha256": "e455c07531476cbcfe0709e3c6408c3b3e129a6ccdbb5e32561cdf62eea4184f" }, "downloads": -1, "filename": "apluslms_roman-0.2.1rc4-py3-none-any.whl", "has_sig": false, "md5_digest": "2caf347090f6faa688bd2368f2c9f79a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12939, "upload_time": "2018-02-21T20:23:08", "url": "https://files.pythonhosted.org/packages/8f/17/aa27d9e53bc133f109d5d1d39e5c2fe0ea8c0791cc9e3264d30c5a36ce77/apluslms_roman-0.2.1rc4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da515f96a6853afea67f0cfc7ce68135", "sha256": "6a26db4554d15e8518de5e96b6e02c162ea77ca6c3887ce2954026a18daebce8" }, "downloads": -1, "filename": "apluslms-roman-0.2.1rc4.tar.gz", "has_sig": false, "md5_digest": "da515f96a6853afea67f0cfc7ce68135", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8586, "upload_time": "2018-02-21T20:23:09", "url": "https://files.pythonhosted.org/packages/34/6f/338cd49ec42159c6b35bfd5f01e79b4118be80b7c24a8cebf55f7dad4cba/apluslms-roman-0.2.1rc4.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "2caf347090f6faa688bd2368f2c9f79a", "sha256": "e455c07531476cbcfe0709e3c6408c3b3e129a6ccdbb5e32561cdf62eea4184f" }, "downloads": -1, "filename": "apluslms_roman-0.2.1rc4-py3-none-any.whl", "has_sig": false, "md5_digest": "2caf347090f6faa688bd2368f2c9f79a", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 12939, "upload_time": "2018-02-21T20:23:08", "url": "https://files.pythonhosted.org/packages/8f/17/aa27d9e53bc133f109d5d1d39e5c2fe0ea8c0791cc9e3264d30c5a36ce77/apluslms_roman-0.2.1rc4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "da515f96a6853afea67f0cfc7ce68135", "sha256": "6a26db4554d15e8518de5e96b6e02c162ea77ca6c3887ce2954026a18daebce8" }, "downloads": -1, "filename": "apluslms-roman-0.2.1rc4.tar.gz", "has_sig": false, "md5_digest": "da515f96a6853afea67f0cfc7ce68135", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 8586, "upload_time": "2018-02-21T20:23:09", "url": "https://files.pythonhosted.org/packages/34/6f/338cd49ec42159c6b35bfd5f01e79b4118be80b7c24a8cebf55f7dad4cba/apluslms-roman-0.2.1rc4.tar.gz" } ] }