| Name | py-gfm JSON |
| Version |
2.0.0
JSON |
| download |
| home_page | https://github.com/zopieux/py-gfm |
| Summary | An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library. |
| upload_time | 2022-11-18 20:24:52 |
| maintainer | |
| docs_url | https://pythonhosted.org/py-gfm/ |
| author | Dart Team, Alexandre Macabies |
| requires_python | >=3.8 |
| license | |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
|
| coveralls test coverage |
|
GitHub-Flavored Markdown for Python
===================================
**PLEASE READ BEFORE USING:**
**This repository will not receive bug fixes, and might become read-only soon.**
Rationale: this library has well-known `consistency issues`_ with GitHub-Flavored Markdown rendering. Fixing
them would require time investment the maintainer cannot provide. The maintainer is also fatigued by
Markdown's library constantly breaking their internal API with each minor release.
**Consider instead using** |pycmarkgfm|_ (PyPi_), a lightweight Python 3.5+ wrapper for GitHub's
own implementation of GFM from the same author,
which is faster, virtually byte-compatible with GitHub rendering,
and provides a nice API for managing task lists aka. TODO lists.
.. _`consistency issues`: https://github.com/Zopieux/py-gfm/issues?q=is%3Aissue+is%3Aopen+label%3Aconformance
.. _pycmarkgfm: https://github.com/Zopieux/pycmarkgfm
.. |pycmarkgfm| replace:: **pycmarkgfm**
.. _PyPi: https://pypi.org/project/pycmarkgfm/
|Build status| |Coverage status| |Documentation status|
This is an implementation of `GitHub-Flavored Markdown`_ written as an
extension to the Python `Markdown`_ library. It aims for, but does not
achieve, maximal compatibility with GitHub's rendering.
Tested Python versions are 3.5 to 3.8. Sorry, no Python 2.7 support starting
with py-gfm 1.x since the Python Markdown library itself is Python 3 only.
Documentation
-------------
You can browse or download the precompiled documentation
on `Read the Docs`_.
To build the Sphinx documentation from source, use::
cd doc && make html
Supported features
------------------
- Fenced code blocks
- Literal line breaks
- Tables
- Hyperlink parsing (``http``, ``https``, ``ftp``, ``email`` and
``www`` subdomains)
- Code highlighting for code blocks if Pygments is available
- Mixed-style lists with no separation
- Strikethrough
- Task lists
Unsupported features and known differences
------------------------------------------
py-gfm is a pure Python implementation based on the Python Markdown library and
therefore cannot reproduce GitHub's `own implementation`_ with 100% accuracy.
See `the docs`_ for a list of known discrepancies.
License
-------
BSD-style. See `LICENSE`_.
.. _GitHub-Flavored Markdown: https://docs.github.com/en/github/writing-on-github
.. _Markdown: https://python-markdown.github.io/
.. _Read the Docs: https://py-gfm.readthedocs.io/
.. _LICENSE: /LICENSE
.. _`the docs`: https://py-gfm.readthedocs.io/#unsupported-features
.. _`own implementation`: https://github.com/github/cmark-gfm
.. |Build status| image:: https://github.com/Zopieux/py-gfm/workflows/Test%20and%20package/badge.svg
:target: https://github.com/Zopieux/py-gfm/actions?query=workflow%3A%22Test+and+package%22
:alt: Build status
.. |Coverage status| image:: https://coveralls.io/repos/github/Zopieux/py-gfm/badge.svg?branch=master
:target: https://coveralls.io/github/Zopieux/py-gfm?branch=master
:alt: Coverage status
.. |Documentation status| image:: https://readthedocs.org/projects/py-gfm/badge/?version=latest
:target: https://py-gfm.readthedocs.org/en/latest/?badge=latest
:alt: Documentation Status
Raw data
{
"_id": null,
"home_page": "https://github.com/zopieux/py-gfm",
"name": "py-gfm",
"maintainer": "",
"docs_url": "https://pythonhosted.org/py-gfm/",
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "Dart Team, Alexandre Macabies",
"author_email": "web+oss@zopieux.com",
"download_url": "https://files.pythonhosted.org/packages/29/38/30d207abd8f8d7ffc66495f2329442c70727e381cadd472bb94b72e4d150/py-gfm-2.0.0.linux-x86_64.tar.gz",
"platform": null,
"description": "GitHub-Flavored Markdown for Python\n===================================\n\n**PLEASE READ BEFORE USING:**\n**This repository will not receive bug fixes, and might become read-only soon.**\n\nRationale: this library has well-known `consistency issues`_ with GitHub-Flavored Markdown rendering. Fixing\nthem would require time investment the maintainer cannot provide. The maintainer is also fatigued by\nMarkdown's library constantly breaking their internal API with each minor release.\n\n**Consider instead using** |pycmarkgfm|_ (PyPi_), a lightweight Python 3.5+ wrapper for GitHub's \nown implementation of GFM from the same author,\nwhich is faster, virtually byte-compatible with GitHub rendering,\nand provides a nice API for managing task lists aka. TODO lists.\n\n.. _`consistency issues`: https://github.com/Zopieux/py-gfm/issues?q=is%3Aissue+is%3Aopen+label%3Aconformance\n.. _pycmarkgfm: https://github.com/Zopieux/pycmarkgfm\n.. |pycmarkgfm| replace:: **pycmarkgfm**\n.. _PyPi: https://pypi.org/project/pycmarkgfm/\n\n|Build status| |Coverage status| |Documentation status|\n\nThis is an implementation of `GitHub-Flavored Markdown`_ written as an\nextension to the Python `Markdown`_ library. It aims for, but does not\nachieve, maximal compatibility with GitHub's rendering.\n\nTested Python versions are 3.5 to 3.8. Sorry, no Python 2.7 support starting\nwith py-gfm 1.x since the Python Markdown library itself is Python 3 only.\n\nDocumentation\n-------------\n\nYou can browse or download the precompiled documentation\non `Read the Docs`_.\n\nTo build the Sphinx documentation from source, use::\n\n cd doc && make html\n\nSupported features\n------------------\n\n- Fenced code blocks\n- Literal line breaks\n- Tables\n- Hyperlink parsing (``http``, ``https``, ``ftp``, ``email`` and\n ``www`` subdomains)\n- Code highlighting for code blocks if Pygments is available\n- Mixed-style lists with no separation\n- Strikethrough\n- Task lists\n\nUnsupported features and known differences\n------------------------------------------\n\npy-gfm is a pure Python implementation based on the Python Markdown library and\ntherefore cannot reproduce GitHub's `own implementation`_ with 100% accuracy.\n\nSee `the docs`_ for a list of known discrepancies.\n\nLicense\n-------\n\nBSD-style. See `LICENSE`_.\n\n.. _GitHub-Flavored Markdown: https://docs.github.com/en/github/writing-on-github\n.. _Markdown: https://python-markdown.github.io/\n.. _Read the Docs: https://py-gfm.readthedocs.io/\n.. _LICENSE: /LICENSE\n.. _`the docs`: https://py-gfm.readthedocs.io/#unsupported-features\n.. _`own implementation`: https://github.com/github/cmark-gfm\n\n.. |Build status| image:: https://github.com/Zopieux/py-gfm/workflows/Test%20and%20package/badge.svg\n :target: https://github.com/Zopieux/py-gfm/actions?query=workflow%3A%22Test+and+package%22\n :alt: Build status\n.. |Coverage status| image:: https://coveralls.io/repos/github/Zopieux/py-gfm/badge.svg?branch=master\n :target: https://coveralls.io/github/Zopieux/py-gfm?branch=master\n :alt: Coverage status\n.. |Documentation status| image:: https://readthedocs.org/projects/py-gfm/badge/?version=latest\n :target: https://py-gfm.readthedocs.org/en/latest/?badge=latest\n :alt: Documentation Status\n",
"bugtrack_url": null,
"license": "",
"summary": "An implementation of Github-Flavored Markdown written as an extension to the Python Markdown library.",
"version": "2.0.0",
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "293830d207abd8f8d7ffc66495f2329442c70727e381cadd472bb94b72e4d150",
"md5": "ae356876453ea63185e46ddac9cc0099",
"sha256": "8768b31bbfda8e1d52e2f32b363c138eedf52b1a81c06036b60ece576b2a652f"
},
"downloads": -1,
"filename": "py-gfm-2.0.0.linux-x86_64.tar.gz",
"has_sig": false,
"md5_digest": "ae356876453ea63185e46ddac9cc0099",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 19250,
"upload_time": "2022-11-18T20:24:52",
"upload_time_iso_8601": "2022-11-18T20:24:52.379859Z",
"url": "https://files.pythonhosted.org/packages/29/38/30d207abd8f8d7ffc66495f2329442c70727e381cadd472bb94b72e4d150/py-gfm-2.0.0.linux-x86_64.tar.gz",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "2d3b6d8adfd7ffbddcebea22cebd40679fee0332dbc85ec95e6179fefbaedfdd",
"md5": "55795a1bbcfc5bff7d1351dcf745aa4b",
"sha256": "c49f43b584e15bdbe569141c92aefc00542289b6d88d95b38117e3359a35cdfe"
},
"downloads": -1,
"filename": "py_gfm-2.0.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "55795a1bbcfc5bff7d1351dcf745aa4b",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": ">=3.8",
"size": 16182,
"upload_time": "2022-11-18T20:24:48",
"upload_time_iso_8601": "2022-11-18T20:24:48.922432Z",
"url": "https://files.pythonhosted.org/packages/2d/3b/6d8adfd7ffbddcebea22cebd40679fee0332dbc85ec95e6179fefbaedfdd/py_gfm-2.0.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2022-11-18 20:24:52",
"github": true,
"gitlab": false,
"bitbucket": false,
"github_user": "zopieux",
"github_project": "py-gfm",
"travis_ci": true,
"coveralls": true,
"github_actions": true,
"lcname": "py-gfm"
}
