{ "info": { "author": "Brian Okken", "author_email": "", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License" ], "description": "# submark\nSubset of Markdown\n\nThis project started as an example project to describe migrating from a script to a package, utilizing flit, tox, coverage, and pytest. \n\nSee http://testandcode.com/80 for the story.\n\n## Features\n\n* Convert headings \n * `# heading` -> `

heading

`\n * `## heading` -> `

heading

`\n * `### heading` -> `

heading

`\n * `#### heading` -> `

heading

`\n * `##### heading` -> `
heading
`\n\n* Convert strong\n * `**strong**` -> `strong`\n * `__strong__`-> `strong`\n\n\n* Convert em\n * `**something**` -> `something`\n * `__something__`-> `something`\n\n* links\n * `[message](http://some.link.html \"my title\")` \n -> `message`\n * `[message](http://some.link.html)` \n -> `message`\n\n* images\n * `![alt](/some/image.png \"title\")'` \n -> `'`\n \n* inline code\n * ``this is `some code` `` \n -> `this is some code `\n \n* line breaks with two spaces at end of text\n* horizontal rules, 3 or more dashes\n * `---` -> `
`\n\n## Usage\n\nUse it like this:\n~~~\n$ submark something.md > something.html\n~~~\n\nor:\n~~~\n$ cat something.md | submark > something.html\n~~~\n\nor:\n~~~\n$ echo '**hi**' | submark\nhi\n~~~\n\n## Dev & Test virtual environment\n\nTesting and development should be done with a virtual environment.\n\n~~~\n$ git clone https://github.com/okken/submark.git\n$ cd submark\n$ python3 -m venv venv --prompt submark\n$ source venv/bin/activate\n(submark) $ pip install -U pip\n~~~\n\n\n### Testing\n\nTesting is done with `tox`.\n\n~~~\n(submark) $ pip install tox\n(submark) $ tox\n~~~\n\n### Development\n\nDevelopment requires a few tools. \nInstall submark locally and install dev tools with flit.\n\n~~~\n(submark) $ pip install flit\n(submark) $ flit install --pth-file\n~~~\n\nThen you can test any changes locally with pytest.\n\n~~~\n(submark) $ pytest --cov=submark \n~~~\n\nAnd when ready to test everything as an installed package:\n\n~~~\n(submark) $ tox\n~~~\n\n\n\n### Building a wheel\n\nMake sure everything is committed before running `flit`.\n\n~~~\n(submark) $ pip install flit\n(submark) $ flit build\n~~~\n\nYep. That's it. \nThere should be a wheel now sitting in a `dist` folder.\n\n~~~\n(submark) $ ls dist\nsubmark-0.5-py2.py3-none-any.whl\nsubmark-0.5.tar.gz\n~~~\n\n## Deploying\n\nFlit does that too.\n\n~~~\n(submark) $ flit publish\n~~~\n\nBut don't do that unless:\n\n* You are Brian Okken\n\nor:\n\n* You are pointing to something other than pypi\n* see https://flit.readthedocs.io/en/latest/upload.html\n\n\n\n## History\n\n* 0.1 Initial script and tests\n* 0.2 build wheel with flit\n* 0.3 build and test with tox\n* 0.4 move source module into a package directory\n* 0.5 move tests into tests directory\n* 0.6 hook up readme in toml file\n* 0.7 \n * flit for development with requires-extra,\n * support for links, images, inline code, line breaks, horizontal rules\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/okken/submark", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "submark", "package_url": "https://pypi.org/project/submark/", "platform": "", "project_url": "https://pypi.org/project/submark/", "project_urls": { "Homepage": "https://github.com/okken/submark" }, "release_url": "https://pypi.org/project/submark/0.7/", "requires_dist": [ "pytest; extra == \"test\"", "pytest-cov; extra == \"test\"", "tox; extra == \"test\"" ], "requires_python": "", "summary": "A Subset of Markdown", "version": "0.7" }, "last_serial": 5515232, "releases": { "0.2": [ { "comment_text": "", "digests": { "md5": "5fbde37e21beddbbedbb88c1913a7961", "sha256": "a9b9814b9cee51256029bbb58767e781c71f7d1b114c66594b2cf02effbf8612" }, "downloads": -1, "filename": "submark-0.2-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "5fbde37e21beddbbedbb88c1913a7961", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 3535, "upload_time": "2019-07-01T04:39:20", "url": "https://files.pythonhosted.org/packages/33/df/90f42192a46e1886f2392643c565016d8fd7f8af949cb6865f581b3a7a75/submark-0.2-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "e9f522c839833a50291d815359314166", "sha256": "832254431657fdcc9c4419516e6406798b324658840d402284b6be130b5b6c69" }, "downloads": -1, "filename": "submark-0.2.tar.gz", "has_sig": false, "md5_digest": "e9f522c839833a50291d815359314166", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2629, "upload_time": "2019-07-01T04:39:22", "url": "https://files.pythonhosted.org/packages/84/7d/3d840a84b5c736fcea66e070000429baf8f897ed1e00f14c8e82136da682/submark-0.2.tar.gz" } ], "0.4": [ { "comment_text": "", "digests": { "md5": "e2377910114f01250052684e340a1c9c", "sha256": "4c7675191f3743a3006348e7261a17ffb350aea162b33e474b74149e75410cd2" }, "downloads": -1, "filename": "submark-0.4-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "e2377910114f01250052684e340a1c9c", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4145, "upload_time": "2019-07-03T04:40:54", "url": "https://files.pythonhosted.org/packages/7b/81/117d3524e1135c546f02fa0a25e392983fa1e1670b43c568014370ce0b44/submark-0.4-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "328bb71d4731c6c9ac827f4fb94f120d", "sha256": "03be542fb6009ed138d8bc49dff81a9eb87a353e5b1586be66d764a860a272f2" }, "downloads": -1, "filename": "submark-0.4.tar.gz", "has_sig": false, "md5_digest": "328bb71d4731c6c9ac827f4fb94f120d", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 2965, "upload_time": "2019-07-03T04:40:55", "url": "https://files.pythonhosted.org/packages/c1/50/98618f06f0eb51fc5dccd7c685922403c832c143d6ec3c2b398214d34ed3/submark-0.4.tar.gz" } ], "0.5": [ { "comment_text": "", "digests": { "md5": "9e4cb6db61bd69091400453da64a9e2d", "sha256": "fd5e911328d9edbd02857159214cfbf0b7691d64602d75e89ceb961046e491fb" }, "downloads": -1, "filename": "submark-0.5-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "9e4cb6db61bd69091400453da64a9e2d", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4136, "upload_time": "2019-07-04T06:08:26", "url": "https://files.pythonhosted.org/packages/43/55/0882526a50f2543f9f645c2ae2debbbf996a9a91f6a28317ae766e564f2e/submark-0.5-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4c60bb109206c4643331aa79feeefe09", "sha256": "f15de09e16781ca17a910a5b1b1c4cf632063a0509be7a51b74a78c0f4343f24" }, "downloads": -1, "filename": "submark-0.5.tar.gz", "has_sig": false, "md5_digest": "4c60bb109206c4643331aa79feeefe09", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 3911, "upload_time": "2019-07-04T06:08:28", "url": "https://files.pythonhosted.org/packages/f8/12/860585a7ebca2a9709ac66865432e301708495b7b316dc67d5b66815a988/submark-0.5.tar.gz" } ], "0.6": [ { "comment_text": "", "digests": { "md5": "248a07bdc7d6f3f2732553f63294aab9", "sha256": "2cf9ebb96ab0a3b9946da5633c49ac512433f93c6a009d4f0d8942865d0f0146" }, "downloads": -1, "filename": "submark-0.6-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "248a07bdc7d6f3f2732553f63294aab9", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 4986, "upload_time": "2019-07-04T16:55:11", "url": "https://files.pythonhosted.org/packages/f7/c4/99de352e03abe534bd1afea92304d50bad7385f4ad768b60e6bf0cf6b309/submark-0.6-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "79c826caadfe5e3b3beba8f02d6f2e9c", "sha256": "a6251e1bbf0f4fa63484a4f43d0caec3e70a513d4f138603075428701f0044cd" }, "downloads": -1, "filename": "submark-0.6.tar.gz", "has_sig": false, "md5_digest": "79c826caadfe5e3b3beba8f02d6f2e9c", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4045, "upload_time": "2019-07-04T16:55:12", "url": "https://files.pythonhosted.org/packages/e7/d0/26c493bbd8d0bb56e0360c0b07dd447c27a6a6a767b017852c37b838ddc7/submark-0.6.tar.gz" } ], "0.7": [ { "comment_text": "", "digests": { "md5": "f8c827fd090467859690ede1709ae7c0", "sha256": "99907020cdf75d12c45f64629a5aab579bedbe3c2b4f025201cb6bee88117c96" }, "downloads": -1, "filename": "submark-0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f8c827fd090467859690ede1709ae7c0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6585, "upload_time": "2019-07-11T05:01:43", "url": "https://files.pythonhosted.org/packages/f1/3d/5420909c7c4522235230921b673f970daefa64339f314b39c2d6cb85b149/submark-0.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3257b797f1cae3e17b0b12bce1b7f26a", "sha256": "c7d5bfae94ed81231330c738a46cdaef47843a032ac07fb0850389b7f42ba6ae" }, "downloads": -1, "filename": "submark-0.7.tar.gz", "has_sig": false, "md5_digest": "3257b797f1cae3e17b0b12bce1b7f26a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4940, "upload_time": "2019-07-11T05:01:45", "url": "https://files.pythonhosted.org/packages/67/2d/c7e85df74e7e24ef40ad84e344599ad8d68761b38a0b58787ba092670f2b/submark-0.7.tar.gz" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "f8c827fd090467859690ede1709ae7c0", "sha256": "99907020cdf75d12c45f64629a5aab579bedbe3c2b4f025201cb6bee88117c96" }, "downloads": -1, "filename": "submark-0.7-py2.py3-none-any.whl", "has_sig": false, "md5_digest": "f8c827fd090467859690ede1709ae7c0", "packagetype": "bdist_wheel", "python_version": "py2.py3", "requires_python": null, "size": 6585, "upload_time": "2019-07-11T05:01:43", "url": "https://files.pythonhosted.org/packages/f1/3d/5420909c7c4522235230921b673f970daefa64339f314b39c2d6cb85b149/submark-0.7-py2.py3-none-any.whl" }, { "comment_text": "", "digests": { "md5": "3257b797f1cae3e17b0b12bce1b7f26a", "sha256": "c7d5bfae94ed81231330c738a46cdaef47843a032ac07fb0850389b7f42ba6ae" }, "downloads": -1, "filename": "submark-0.7.tar.gz", "has_sig": false, "md5_digest": "3257b797f1cae3e17b0b12bce1b7f26a", "packagetype": "sdist", "python_version": "source", "requires_python": null, "size": 4940, "upload_time": "2019-07-11T05:01:45", "url": "https://files.pythonhosted.org/packages/67/2d/c7e85df74e7e24ef40ad84e344599ad8d68761b38a0b58787ba092670f2b/submark-0.7.tar.gz" } ] }