{
    "info": {
        "author": "Phil Barker",
        "author_email": "phil.barker@pjjk.co.uk",
        "bugtrack_url": null,
        "classifiers": [
            "Development Status :: 4 - Beta",
            "License :: OSI Approved :: Apache Software License",
            "Programming Language :: Python :: 3.6",
            "Programming Language :: Python :: 3.7",
            "Topic :: Text Processing :: Markup :: HTML"
        ],
        "description": "[![Build Status](https://travis-ci.org/philbarker/ocxsect.svg?branch=master)](https://travis-ci.org/philbarker/ocxsect)\n[![Coverage](https://codecov.io/gh/philbarker/ocxsect/branch/master/graph/badge.svg)](https://codecov.io/gh/philbarker/ocxsect/)\n\n# Sectioning in markdown\nAn extension to [python markdown](https://python-markdown.github.io/) that allows you to add semantic HTML5 sectioning elements into the generated html by putting strings such as `~~S~~` at the start of a section and `~~/S~~` at the end. Sectioning elements supported are `<section>`, `<chapter>`, `<header>`, `<footer>`, `<nav>`, `<div>`, and `<article>`. These can be given identifiers by adding text after the sectioning element letter, e.g. `~~S section1~~` to give `<section id=\"section1\">`. A schematic representation of the structure (useful for debugging) is also generated and stored as the markdown.Markdown.tree_diagram property of the markdown object.\n\n## Requirements & dependencies\nPython 3 (tested on Python 3.6 and 3.7)\n\nDesigned for use with [MkDocs](https://www.mkdocs.org/#installation)\n\nUses python packages [Python-Markdown](https://python-markdown.github.io/install/), [Python re](https://docs.python.org/3/library/re.html), [xml.etree.ElementTree](https://docs.python.org/3.7/library/xml.etree.elementtree.html) and [re - Regular expression operations](https://docs.python.org/3/library/re.html)\n\nInstallation from github source with setup.py requires [setuptools](https://setuptools.readthedocs.io/en/latest/setuptools.html#installing-setuptools)\n\nDoesn't play nicely with other python markdown extensions that use `~~~` to delineate markup, notably it can lead to text being shown as struck through.\n\n## Installation\n__Warning:__  The xml.etree.ElementTree module is not secure against maliciously constructed data. If you need to parse untrusted or unauthenticated data see [XML vulnerabilities](https://docs.python.org/3.7/library/xml.html#xml-vulnerabilities).\n\n__Warning:__ exercise caution this early release software with no warranty, test this first in a virtual environment!\n\nInstall from pypi:\n```\n(venv)$ pip install ocxsect\n```\n\nOr install from github:\n```\n(venv)$ git clone https://github.com/philbarker/ocxsect.git\n(venv)$ cd ocxsect\n(venv)$ python setup.py test\n(venv)$ python setup.py install\n(venv)$ python test.py\n```\n\n## Usage\nTo create a new section put `~~X~~` on a line by itself, where X represents the type of HTML5 sectioning element you want to create. Sectioning elements supported are `section` (S), `chapter` (C) `header` (H) `footer` (F) `nav` (N) `div` (D) and `article` (A). These can be given identifiers by add text after the sectioning element letter, e.g. `~~S lesson1~~`. In order to avoid non-URL safe characters in the identifier any character not in the set A-Z, a-z, 0-9, !$-()+ is removed. So `~~A #activity 1~~` becomes `<article id=\"activity1\">`.  \n\n## Usage in MkDocs\nAfter installation, add `ocxsect` to your extensions block in mkdocs.yml:\n```\nmarkdown_extensions:\n  - ocxsect\n```\n\n## Example\n\n### Markdown input\n\n```\n~~C lesson1~~\n\n~~H~~\n#Markdown structure test\nThis is in the header section of a chapter. The chapter has id #lesson1. The header has no id.\n\n~~/H~~\n\n~~S section 1~~\n#Activity 1\nThis is in a regular section (id #section1) of a chapter\n\n~~/S~~\n\n~~F~~\n\nThis is in the footer of the chapter\n\n~~/F~~\n\n~~/C~~\n```\n\n### Schematic representation of structure\n\n```\n|--chapter{'id': 'lesson1'}\n    |--header\n        |--h1\n        |--p\n    |--section{'id': 'section1'}\n        |--h1\n        |--p\n    |--footer\n        |--p\n|--p\n```\n\n### HTML output\n\n```\n<chapter id=\"lesson1\">\n  <header>\n    <h1>Markdown structure test</h1>\n    <p>This is in the header section of a chapter. The chapter has id #lesson1. The header has no id.</p>\n  </header>\n  <section id=\"section1\">\n    <h1>Activity 1</h1>\n    <p>This is in a regular section (id #section1) of a chapter</p>\n  </section>\n  <footer>\n    <p>This is in the footer of the chapter</p>\n  </footer>\n</chapter>\n<p>This is after the chapter</p>\n```\n\nSee test.py for a fully working example embedded in markdown.\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/philbarker/ocxsect",
        "keywords": "",
        "license": "Apache2",
        "maintainer": "",
        "maintainer_email": "",
        "name": "ocxsect",
        "package_url": "https://pypi.org/project/ocxsect/",
        "platform": "",
        "project_url": "https://pypi.org/project/ocxsect/",
        "project_urls": {
            "Homepage": "https://github.com/philbarker/ocxsect"
        },
        "release_url": "https://pypi.org/project/ocxsect/0.1.5/",
        "requires_dist": [
            "setuptools (>=40.6)"
        ],
        "requires_python": "",
        "summary": "A python markdown extension that allows you to add semantic HTML5 sectioning elements into the generated html.",
        "version": "0.1.5"
    },
    "last_serial": 5682628,
    "releases": {
        "0.1.3": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "2feb5de2c825a646aa8669e1316d186a",
                    "sha256": "82aafab2c562cdbc8624adb59b1682da57b84cb06c8cc5e3bf2a31508283c710"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.3-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "2feb5de2c825a646aa8669e1316d186a",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8949,
                "upload_time": "2019-08-15T14:30:02",
                "url": "https://files.pythonhosted.org/packages/8a/88/b2b5b86a85cd38c6715b2571d50cd8e5e485fe8e1c58b1322a365deee140/ocxsect-0.1.3-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "850a2c4e351544c7953eb759b7cf04d9",
                    "sha256": "94a8839156587a45417c6fcfb618b80f75698f5e3331557df6e80bdf13878847"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.3.tar.gz",
                "has_sig": false,
                "md5_digest": "850a2c4e351544c7953eb759b7cf04d9",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4846,
                "upload_time": "2019-08-15T14:30:04",
                "url": "https://files.pythonhosted.org/packages/22/09/50f48857d22e10fee58c484f76e649f048c0928efb2e98acdf1a05625c9c/ocxsect-0.1.3.tar.gz"
            }
        ],
        "0.1.4": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "8b4af03c2991e1df61c34a2a69f18943",
                    "sha256": "0063f93e570b51d4f5ff2eda8b53c82c094c3e4c7cf5bb003219f963a16e0108"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.4-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "8b4af03c2991e1df61c34a2a69f18943",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8979,
                "upload_time": "2019-08-15T14:43:45",
                "url": "https://files.pythonhosted.org/packages/c6/c4/81e46db8c58b3d687445f6647a0894ad5726f5e2b410acca4d1695e63f83/ocxsect-0.1.4-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "6ba9b1817be0f9c3d77ef9480ccd4041",
                    "sha256": "81e7c3df97fa06e73eb96404a1c2eabc71ad91747a00a7be7f5407560d5e7069"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.4.tar.gz",
                "has_sig": false,
                "md5_digest": "6ba9b1817be0f9c3d77ef9480ccd4041",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4896,
                "upload_time": "2019-08-15T14:43:47",
                "url": "https://files.pythonhosted.org/packages/d2/a4/8da8732a0b26d392a52212d599eb5852031011b2ff6ea10e27f97859cdfc/ocxsect-0.1.4.tar.gz"
            }
        ],
        "0.1.5": [
            {
                "comment_text": "",
                "digests": {
                    "md5": "abcd653303f6d05a4fb727d00bce3fe9",
                    "sha256": "dacf2a674ca38b06c991aae231c1cb31a0234ef8c2c6500a698b4558db962169"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.5-py2.py3-none-any.whl",
                "has_sig": false,
                "md5_digest": "abcd653303f6d05a4fb727d00bce3fe9",
                "packagetype": "bdist_wheel",
                "python_version": "py2.py3",
                "requires_python": null,
                "size": 8982,
                "upload_time": "2019-08-15T15:01:13",
                "url": "https://files.pythonhosted.org/packages/1a/7d/ada45862d37e40839666ab525140a8b42c4b8bad2f2205c34ad40f89b167/ocxsect-0.1.5-py2.py3-none-any.whl"
            },
            {
                "comment_text": "",
                "digests": {
                    "md5": "f0b63f2f26911cec3f7f9aa905645b37",
                    "sha256": "c55a0c9b9666d5562a57b9263f6a8442ec988c17ddd4c8df8f85d0f076fb7465"
                },
                "downloads": -1,
                "filename": "ocxsect-0.1.5.tar.gz",
                "has_sig": false,
                "md5_digest": "f0b63f2f26911cec3f7f9aa905645b37",
                "packagetype": "sdist",
                "python_version": "source",
                "requires_python": null,
                "size": 4896,
                "upload_time": "2019-08-15T15:01:14",
                "url": "https://files.pythonhosted.org/packages/56/3d/4ea68d470bbffcc3ce752ccf21430a8924bc301723cc390c1527afca5a85/ocxsect-0.1.5.tar.gz"
            }
        ]
    },
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "md5": "abcd653303f6d05a4fb727d00bce3fe9",
                "sha256": "dacf2a674ca38b06c991aae231c1cb31a0234ef8c2c6500a698b4558db962169"
            },
            "downloads": -1,
            "filename": "ocxsect-0.1.5-py2.py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "abcd653303f6d05a4fb727d00bce3fe9",
            "packagetype": "bdist_wheel",
            "python_version": "py2.py3",
            "requires_python": null,
            "size": 8982,
            "upload_time": "2019-08-15T15:01:13",
            "url": "https://files.pythonhosted.org/packages/1a/7d/ada45862d37e40839666ab525140a8b42c4b8bad2f2205c34ad40f89b167/ocxsect-0.1.5-py2.py3-none-any.whl"
        },
        {
            "comment_text": "",
            "digests": {
                "md5": "f0b63f2f26911cec3f7f9aa905645b37",
                "sha256": "c55a0c9b9666d5562a57b9263f6a8442ec988c17ddd4c8df8f85d0f076fb7465"
            },
            "downloads": -1,
            "filename": "ocxsect-0.1.5.tar.gz",
            "has_sig": false,
            "md5_digest": "f0b63f2f26911cec3f7f9aa905645b37",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": null,
            "size": 4896,
            "upload_time": "2019-08-15T15:01:14",
            "url": "https://files.pythonhosted.org/packages/56/3d/4ea68d470bbffcc3ce752ccf21430a8924bc301723cc390c1527afca5a85/ocxsect-0.1.5.tar.gz"
        }
    ]
}