{ "info": { "author": "naucse.python.cz contributors", "author_email": "encukou@gmail.com", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Programming Language :: Python", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "# naucse_render\n\nHelper for converting course material in YAML/Markdown/Jupyter to\nnaucse.python.cz JSON API.\n\n\n# Entrypoints\n\nThere are two public entrypoints: one for getting general course information;\nthe other for a subset of lessons.\n\n(This separation means the content doesn't need to be rendered to get course\ninfo.)\n\n`naucse_render.get_course(course_slug, *, path='.', version=None)`\n\n`naucse_render.get_lessons(lesson_slugs, vars=None, path='.')`\n\nThe `path` specifies the local filesystem path to the root of the repository\n(i.e. parent directory of `courses`, `runs` and `lessons`).\n\n\n# Installation & Usage\n\nYou can run naucse_render from the command line:\n\n```console\npython -m naucse_render get-course courses/mi-pyt\n\npython -m naucse_render get-lessons beginners/install beginners/venv-setup\n```\n\nBy default, data is retreived from the current working directory.\nUse the `--path` option to point naucse_render elsewhere.\n\n\n## Tests\n\nTo tests, install `pipenv`, and install dependencies:\n\n```console\n$ pipenv install --dev\n```\n\nthen run the tests:\n\n```console\n$ pipenv run test\n```\n\n\n# License\n\nThe code is licensed under the terms of the MIT license, see [LICENSE.MIT] file\nfor full text. By contributing code to this repository, you agree to have it\nlicensed under the same license.\n\n[LICENSE.MIT]: https://github.com/pyvec/naucse.python.cz/blob/master/LICENSE.MIT\n\n\n## Changelog\n\n### naucse_render 1.2\n\n* API version 0.1\n* Serial \"numbers\" are now generated for sessions.\n * Serials are strings (or None). Usually they are numeric (like `'1'`),\n and in the source YAML they may be specified as int.\n But, for example, an appendix could use Roman numerals: `i`, `ii`, `iii`.\n * When a serial is not given in the source YAML explicitly, it is\n auto-generated as the previous serial plus 1 (or from `1` at the start).\n Serials specified as str (or None) prevent this auto-generation.\n * For courses with only one session, the serial is not auto-generated.\n\n\n### naucse_render 1.1\n\n* Make it possible to use data from a YAML file in lesson content\n* Make output the same on Windows as on \"Unixy\" systems\n\n\n### naucse_render 1.0\n\n* Source files are always reported as relative paths\n* YAML files are reloaded when they change\n* Added integration tests\n\n\n### naucse_render 0.x\n\n0.x should successfully render courses hosted on naucse.python.cz\nprior to 2019.\n\nThe format of the source files grew organically, so there is no attempt here\nto document it.\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/pyvec/naucse_render", "keywords": "", "license": "MIT", "maintainer": "Petr Viktorin", "maintainer_email": "encukou@gmail.com", "name": "naucse-render", "package_url": "https://pypi.org/project/naucse-render/", "platform": "", "project_url": "https://pypi.org/project/naucse-render/", "project_urls": { "Homepage": "https://github.com/pyvec/naucse_render" }, "release_url": "https://pypi.org/project/naucse-render/1.2/", "requires_dist": [ "ansi2html", "mistune", "nbconvert", "traitlets", "click", "PyYAML", "Jinja2", "Pygments" ], "requires_python": "", "summary": "Converts course material to naucse.python.cz API", "version": "1.2" }, "last_serial": 4874121, "releases": { "0.0.0": [ { "comment_text": "", "digests": { "md5": "d4f8d45494a6e5609535c6ee8100c2ab", "sha256": "7b50c104d9044ad2114e37cb43e30dcb1a95de1e0f49570365274031a1f5ef1b" }, "downloads": -1, "filename": "naucse_render-0.0.0.tar.gz", "has_sig": false, "md5_digest": "d4f8d45494a6e5609535c6ee8100c2ab", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 1142, "upload_time": "2018-11-28T12:41:00", "url": "https://files.pythonhosted.org/packages/53/c6/97c15f07917ec7bf57ec8f02acdcca5a1c03da73482e08114431e65ce70b/naucse_render-0.0.0.tar.gz" } ], "0.1": [ { "comment_text": "", "digests": { "md5": "15d88d38f4c658c3f6b4864e9a0cca47", "sha256": "38730174ab499182a0a915c210060fceaa0be49ced88677e50865d6365ef9d34" }, "downloads": -1, "filename": "naucse_render-0.1-py3-none-any.whl", "has_sig": false, "md5_digest": "15d88d38f4c658c3f6b4864e9a0cca47", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14398, "upload_time": "2019-01-16T14:35:20", "url": "https://files.pythonhosted.org/packages/79/9b/eadde30486d79f10fb9d7d4da680e1f6f73cc4d7c758d4f456ba2cfbe75f/naucse_render-0.1-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "d9e8fca6770387067c8eeae5f2a3dd0f", "sha256": "66a36b29141d37398a2608e1f9718e850bc36908d1aae653531906b039b3ad58" }, "downloads": -1, "filename": "naucse_render-0.1.tar.gz", "has_sig": false, "md5_digest": "d9e8fca6770387067c8eeae5f2a3dd0f", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 11695, "upload_time": "2019-01-16T14:35:22", "url": "https://files.pythonhosted.org/packages/19/ef/fc5af9a0ea0648ced9ca4c7009211857b29def6368580271c4e6627dc103/naucse_render-0.1.tar.gz" } ], "1.0": [ { "comment_text": "", "digests": { "md5": "34edecbc06fb87d85bd04c843eef322d", "sha256": "e6bb417f189d3795e78edef6bbcf26079a6776fb6eec505eab881a34317264bc" }, "downloads": -1, "filename": "naucse_render-1.0-py3-none-any.whl", "has_sig": false, "md5_digest": "34edecbc06fb87d85bd04c843eef322d", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 14705, "upload_time": "2019-02-08T14:07:28", "url": "https://files.pythonhosted.org/packages/a5/6c/82bc5e5ae0fd1adad5883bf70b08a7c0e124b2255775af99a564b67757b5/naucse_render-1.0-py3-none-any.whl" } ], "1.1": [ { "comment_text": "", "digests": { "md5": "5784960ef3a51c158cb3801847239e74", "sha256": "a1d59668fe459095c52825dac43a4d5e15be96119654a9365a83017688f3817d" }, "downloads": -1, "filename": "naucse_render-1.1-py3-none-any.whl", "has_sig": false, "md5_digest": "5784960ef3a51c158cb3801847239e74", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15489, "upload_time": "2019-02-12T13:21:20", "url": "https://files.pythonhosted.org/packages/66/d3/1e5ffd9f90454cd7b40f79897a743e3bfa42f529c8f977597cb22cb7be24/naucse_render-1.1-py3-none-any.whl" } ], "1.2": [ { "comment_text": "", "digests": { "md5": "aeb1c479ba569ac644bd37e748d7f256", "sha256": "cc0bc86e5439e45312fe53e14e49b9209acfb777ff3cad610732c23bcdf5ffaf" }, "downloads": -1, "filename": "naucse_render-1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "aeb1c479ba569ac644bd37e748d7f256", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15967, "upload_time": "2019-02-27T13:21:52", "url": "https://files.pythonhosted.org/packages/d8/45/7da4e72ebbb86eb4ae3545da17e4e5f4ebf7192c68c6073520616daf1e66/naucse_render-1.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "aeb1c479ba569ac644bd37e748d7f256", "sha256": "cc0bc86e5439e45312fe53e14e49b9209acfb777ff3cad610732c23bcdf5ffaf" }, "downloads": -1, "filename": "naucse_render-1.2-py3-none-any.whl", "has_sig": false, "md5_digest": "aeb1c479ba569ac644bd37e748d7f256", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 15967, "upload_time": "2019-02-27T13:21:52", "url": "https://files.pythonhosted.org/packages/d8/45/7da4e72ebbb86eb4ae3545da17e4e5f4ebf7192c68c6073520616daf1e66/naucse_render-1.2-py3-none-any.whl" } ] }