{ "info": { "author": "edouglass", "author_email": "edouglass@lbl.gov", "bugtrack_url": null, "classifiers": [], "description": "# Yamldown\n\nThis library allows users to load and read \"YAMLdown\" files. That is,\nMarkdown (primarily for github) with YAML embedded inside. Github markdown\nalready renders YAML style text in markdown as a table. This library parses\na yamldown file into its respective YAML and markdown.\n\n## Installation\n\n`pip install yamldown`\n\nFor local installation and development, you can run the make file:\n\n sauron@orthanc:[~]$ cd yamldown\n sauron@orthanc:[yamldown]$ make\n\nThis will create a virtual environemnt `env`, install everything in\n`requirements.txt` and in `setup.py`, run tests, and run mypy, python 3's type\nchecker. Be sure to activate the virtual environment when local developing:\n\n source env/bin/activate\n\nor\n\n . env/bin/activate\n\nTo undo your activated virtual environment, just run the command `deactivate`\n\n## Usage\n\nImporting the yamldown module will let you `load` and `dump` yamldown files.\n`load` receives a file-like object (backed by text in yamldown format) and\nreturns a tuple, first a dictionary with the containing YAML, and second a\nstring with the contents of the Markdown. In this way the yaml can be utilized.\n\nExample:\n\n $ python3\n >>> import io\n >>> import yamldown\n >>> s = \"\"\"\n ...---\n ... things:\n ... - hello\n ... - world\n ... foo: bar\n ... ---\n ... This is some markdown text\"\"\"\n >>> f = io.StringIO(s)\n >>> yml, md = yamldown.load(f)\n >>> print(yml)\n {'things': ['hello', 'world'], 'foo': 'bar'}\n >>>print(md)\n This is some markdown text\n\nTo write out a yamldown file, `dump` takes a dictionary with your yaml data\nand a string of markdown and outputs a string. The order in which the yaml\nappears in the document can be specified with the `yamlfirst` option: `True`\nfor if the yaml should appear first (like in the above example) and `False` to\nappear last.\n\nExample:\n\n $ python3\n >>> import yamldown\n >>> yml = {'things': ['hello', 'world'], 'foo': 'bar'}\n >>> md = \"This is some markdown text\"\n >>> print(yamldown.dump(yml, md))\n ---\n foo: bar\n things:\n - hello\n - world\n\n ---\n This is some markdown text\n\n\n", "description_content_type": "", "docs_url": null, "download_url": "https://github.com/dougli1sqrd/yamldown/archive/0.1.8.tar.gz", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/dougli1sqrd/yamldown", "keywords": "yaml,markdown", "license": "", "maintainer": "", "maintainer_email": "", "name": "yamldown", "package_url": "https://pypi.org/project/yamldown/", "platform": "", "project_url": "https://pypi.org/project/yamldown/", "project_urls": { "Download": "https://github.com/dougli1sqrd/yamldown/archive/0.1.8.tar.gz", "Homepage": "https://github.com/dougli1sqrd/yamldown" }, "release_url": "https://pypi.org/project/yamldown/0.1.8/", "requires_dist": [ "pyYaml" ], "requires_python": "", "summary": "Python library for loading and dumping \"yamldown\" (markdown with embedded yaml) files.", "version": "0.1.8" }, "last_serial": 4983498, "releases": { "0.1.2": [ { "comment_text": "", "digests": { "md5": "edc6e0d593259227792a8c784b23bbb8", "sha256": "6e66a06c7df2387c73edefdc8ecb38bfd8346bcf6e2e61bba36388840bfb95b2" }, "downloads": -1, "filename": "yamldown-0.1.2.tar.gz", "has_sig": false, "md5_digest": "edc6e0d593259227792a8c784b23bbb8", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3177, "upload_time": "2017-04-20T21:41:37", "url": "https://files.pythonhosted.org/packages/60/15/0dee25553514fd6430703cd98fa791acfb7792243253a5c6bad9511f79af/yamldown-0.1.2.tar.gz" } ], "0.1.3": [ { "comment_text": "", "digests": { "md5": "8c355663be98cdbbd929be282ac09a27", "sha256": "4fb4c30317ac6f87c048f817b9f92227ba075c862b246693a35ceb71c284b6ab" }, "downloads": -1, "filename": "yamldown-0.1.3.tar.gz", "has_sig": false, "md5_digest": "8c355663be98cdbbd929be282ac09a27", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3416, "upload_time": "2017-04-20T23:51:29", "url": "https://files.pythonhosted.org/packages/38/ab/6a59f9305c78e41c7bc4f6484df5191f3a94565bfd42d2f5aaec26679df3/yamldown-0.1.3.tar.gz" } ], "0.1.4": [ { "comment_text": "", "digests": { "md5": "29c4794f90960d95952195a2796092b2", "sha256": "b8900f905361f8eb101af251ba2029e568f1909e445cfece1c928c4594f3b1bc" }, "downloads": -1, "filename": "yamldown-0.1.4-py3.7.egg", "has_sig": false, "md5_digest": "29c4794f90960d95952195a2796092b2", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 3047, "upload_time": "2018-11-02T23:48:42", "url": "https://files.pythonhosted.org/packages/63/3a/12fefabb70c3e89a7e5db0740733a4c795892f7aad5511742d662bc12b78/yamldown-0.1.4-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "f5ff97624208528bb3878dca69d64626", "sha256": "b28881cb3b17769b797ac6afcbe7645099ce5f1cd0cef158481c97bd0a96e0fe" }, "downloads": -1, "filename": "yamldown-0.1.4-py3-none-any.whl", "has_sig": false, "md5_digest": "f5ff97624208528bb3878dca69d64626", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4097, "upload_time": "2018-11-02T23:48:40", "url": "https://files.pythonhosted.org/packages/48/54/1b55eb8e9304b9493b077bfdd34f6cc02f99a9b6d3b25a650da25b57ac7a/yamldown-0.1.4-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "9bfa42b2dc39742f1163467621575f13", "sha256": "94e984fbd29b1374c8e3391b4a73b38ad14bec0137b7bdfd419434d6a0c15bfa" }, "downloads": -1, "filename": "yamldown-0.1.4.tar.gz", "has_sig": false, "md5_digest": "9bfa42b2dc39742f1163467621575f13", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3418, "upload_time": "2018-11-02T23:48:43", "url": "https://files.pythonhosted.org/packages/89/51/4f3e0fab79233c11f71e8810b95a2557140aa3d02ec6e3217f51ef1e118b/yamldown-0.1.4.tar.gz" } ], "0.1.6": [ { "comment_text": "", "digests": { "md5": "83295908d0ae7008bc78785ba979fa17", "sha256": "c070f345d45197280c8cb6d721bf9f7789d77168c8a2de019adffd7d154b9e77" }, "downloads": -1, "filename": "yamldown-0.1.6-py3.7.egg", "has_sig": false, "md5_digest": "83295908d0ae7008bc78785ba979fa17", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 3049, "upload_time": "2019-01-31T18:42:58", "url": "https://files.pythonhosted.org/packages/f4/be/7b8f369b3d2fdd282f7031d3e1caaca516207049718d907e7c0e3ae3fa2e/yamldown-0.1.6-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "202823c5f21ffc2636fbae733b012f42", "sha256": "fad9816e3f30bc3902ee95bc168fc9849fb74978e08808b2721d05421ab1ef69" }, "downloads": -1, "filename": "yamldown-0.1.6-py3-none-any.whl", "has_sig": false, "md5_digest": "202823c5f21ffc2636fbae733b012f42", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4097, "upload_time": "2019-01-31T18:42:56", "url": "https://files.pythonhosted.org/packages/ce/b7/3be95f2c0da5a8718413a192a5002da666b5f0b84a91204e7f9b5176ae41/yamldown-0.1.6-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "ed736207e8fa6e9fa05aa07a9dbc32f4", "sha256": "7a11f16b6a52b6ff2a3f2e89eab38715ca7582242289eaf82f5e156b6130b3be" }, "downloads": -1, "filename": "yamldown-0.1.6.tar.gz", "has_sig": false, "md5_digest": "ed736207e8fa6e9fa05aa07a9dbc32f4", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3418, "upload_time": "2019-01-31T18:42:59", "url": "https://files.pythonhosted.org/packages/b8/c8/6ab60bf38f504161ab19922b2145a4652012db993475ddec2e8f16b7a804/yamldown-0.1.6.tar.gz" } ], "0.1.7": [ { "comment_text": "", "digests": { "md5": "b9f38eead9e3fce9b0f240cfd759db0f", "sha256": "bcf6d72a0668d050ed0778b27c0765411daad608f64c18dd50eeb9f372e59888" }, "downloads": -1, "filename": "yamldown-0.1.7-py3.7.egg", "has_sig": false, "md5_digest": "b9f38eead9e3fce9b0f240cfd759db0f", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 3062, "upload_time": "2019-03-11T22:36:49", "url": "https://files.pythonhosted.org/packages/cf/9f/e39ef4ae65edaf081b37f5e353a8db8a01e7c5d2783392cf390d3e2274e0/yamldown-0.1.7-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "4acd04fc5bb19408779212e572ac80b0", "sha256": "d192c2980bad9106ba5069d6bc0867ab9a83a3dddbf1199211d301b3c0398575" }, "downloads": -1, "filename": "yamldown-0.1.7-py3-none-any.whl", "has_sig": false, "md5_digest": "4acd04fc5bb19408779212e572ac80b0", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4108, "upload_time": "2019-03-11T22:36:48", "url": "https://files.pythonhosted.org/packages/f9/30/88b58315619e818e98203e62468e2c666f5f2d9406e25b2ee7a2107c496b/yamldown-0.1.7-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e86b3f659c52479024d83c0a5648a744", "sha256": "10c16f6a0cfcd9e421277da8bf059562921add607b31fbcca957269d83665ec3" }, "downloads": -1, "filename": "yamldown-0.1.7.tar.gz", "has_sig": false, "md5_digest": "e86b3f659c52479024d83c0a5648a744", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3435, "upload_time": "2019-03-11T22:36:50", "url": "https://files.pythonhosted.org/packages/fe/69/1064ee3604f0f87a11770ca5fbca32b4f522e7c40ccbac3517f666bde31c/yamldown-0.1.7.tar.gz" } ], "0.1.8": [ { "comment_text": "", "digests": { "md5": "51c4e95392609f1edab9caf7badf8eed", "sha256": "6e9723d479739efa9423834fad005b31220b097ad42606dd0c8159e10677f27a" }, "downloads": -1, "filename": "yamldown-0.1.8-py3.7.egg", "has_sig": false, "md5_digest": "51c4e95392609f1edab9caf7badf8eed", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 3053, "upload_time": "2019-03-25T16:46:26", "url": "https://files.pythonhosted.org/packages/07/45/78cc7385153a9332d88b76a8cd7a72143974dce66acb2ef9957c0149155d/yamldown-0.1.8-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "db0f9fc6a788876dfc8288d9ba8334ef", "sha256": "936ad7bdbde725d0bd3adb77236aae4eb75388619f31232595f7dd45f7006598" }, "downloads": -1, "filename": "yamldown-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "db0f9fc6a788876dfc8288d9ba8334ef", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4097, "upload_time": "2019-03-25T16:46:25", "url": "https://files.pythonhosted.org/packages/5a/40/b8aa35f5ef831a1d47668cc63c6a29611b5b91a9076fddb3fa5368582a67/yamldown-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc60c60166ff21b130e4a2b5cc55dfe3", "sha256": "ec1056e5ec3c47a7c14f69d343b73256ad12751361f1a833805a8ee722cf883c" }, "downloads": -1, "filename": "yamldown-0.1.8.tar.gz", "has_sig": false, "md5_digest": "bc60c60166ff21b130e4a2b5cc55dfe3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3432, "upload_time": "2019-03-25T16:46:27", "url": "https://files.pythonhosted.org/packages/ed/cb/b64a53c4ca6bd0e0aba74523b434213a5c6a3f583631dc4a97abfe7cc7a1/yamldown-0.1.8.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "51c4e95392609f1edab9caf7badf8eed", "sha256": "6e9723d479739efa9423834fad005b31220b097ad42606dd0c8159e10677f27a" }, "downloads": -1, "filename": "yamldown-0.1.8-py3.7.egg", "has_sig": false, "md5_digest": "51c4e95392609f1edab9caf7badf8eed", "packagetype": "bdist_egg", "python_version": "3.7", "requires_python": null, "size": 3053, "upload_time": "2019-03-25T16:46:26", "url": "https://files.pythonhosted.org/packages/07/45/78cc7385153a9332d88b76a8cd7a72143974dce66acb2ef9957c0149155d/yamldown-0.1.8-py3.7.egg" }, { "comment_text": "", "digests": { "md5": "db0f9fc6a788876dfc8288d9ba8334ef", "sha256": "936ad7bdbde725d0bd3adb77236aae4eb75388619f31232595f7dd45f7006598" }, "downloads": -1, "filename": "yamldown-0.1.8-py3-none-any.whl", "has_sig": false, "md5_digest": "db0f9fc6a788876dfc8288d9ba8334ef", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 4097, "upload_time": "2019-03-25T16:46:25", "url": "https://files.pythonhosted.org/packages/5a/40/b8aa35f5ef831a1d47668cc63c6a29611b5b91a9076fddb3fa5368582a67/yamldown-0.1.8-py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "bc60c60166ff21b130e4a2b5cc55dfe3", "sha256": "ec1056e5ec3c47a7c14f69d343b73256ad12751361f1a833805a8ee722cf883c" }, "downloads": -1, "filename": "yamldown-0.1.8.tar.gz", "has_sig": false, "md5_digest": "bc60c60166ff21b130e4a2b5cc55dfe3", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3432, "upload_time": "2019-03-25T16:46:27", "url": "https://files.pythonhosted.org/packages/ed/cb/b64a53c4ca6bd0e0aba74523b434213a5c6a3f583631dc4a97abfe7cc7a1/yamldown-0.1.8.tar.gz" } ] }