| Name | readme-renderer JSON |
| Version |
43.0
JSON |
| download |
| home_page | |
| Summary | readme_renderer is a library for rendering readme descriptions for Warehouse |
| upload_time | 2024-02-26 16:10:59 |
| maintainer | |
| docs_url | None |
| author | |
| requires_python | >=3.8 |
| license | Apache License, Version 2.0 |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
Readme Renderer
===============
.. image:: https://badge.fury.io/py/readme-renderer.svg
:target: https://badge.fury.io/py/readme-renderer
.. image:: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml/badge.svg
:target: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml
Readme Renderer is a library that will safely render arbitrary
``README`` files into HTML. It is designed to be used in Warehouse_ to
render the ``long_description`` for packages. It can handle Markdown,
reStructuredText (``.rst``), and plain text.
.. _Warehouse: https://github.com/pypa/warehouse
Check Description Locally
-------------------------
To locally check whether your long descriptions will render on PyPI, first
build your distributions, and then use the |twine check|_ command.
Code of Conduct
---------------
Everyone interacting in the readme_renderer project's codebases, issue trackers,
chat rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.
.. |twine check| replace:: ``twine check``
.. _twine check: https://packaging.python.org/guides/making-a-pypi-friendly-readme#validating-restructuredtext-markup
.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md
Copyright © 2014, [The Python Packaging Authority].
Raw data
{
"_id": null,
"home_page": "",
"name": "readme-renderer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "",
"author": "",
"author_email": "The Python Packaging Authority <admin@mail.pypi.org>",
"download_url": "https://files.pythonhosted.org/packages/fe/b5/536c775084d239df6345dccf9b043419c7e3308bc31be4c7882196abc62e/readme_renderer-43.0.tar.gz",
"platform": null,
"description": "Readme Renderer\n===============\n\n.. image:: https://badge.fury.io/py/readme-renderer.svg\n :target: https://badge.fury.io/py/readme-renderer\n\n.. image:: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml/badge.svg\n :target: https://github.com/pypa/readme_renderer/actions/workflows/ci.yml\n\nReadme Renderer is a library that will safely render arbitrary\n``README`` files into HTML. It is designed to be used in Warehouse_ to\nrender the ``long_description`` for packages. It can handle Markdown,\nreStructuredText (``.rst``), and plain text.\n\n.. _Warehouse: https://github.com/pypa/warehouse\n\n\nCheck Description Locally\n-------------------------\n\nTo locally check whether your long descriptions will render on PyPI, first\nbuild your distributions, and then use the |twine check|_ command.\n\n\nCode of Conduct\n---------------\n\nEveryone interacting in the readme_renderer project's codebases, issue trackers,\nchat rooms, and mailing lists is expected to follow the `PSF Code of Conduct`_.\n\n\n.. |twine check| replace:: ``twine check``\n.. _twine check: https://packaging.python.org/guides/making-a-pypi-friendly-readme#validating-restructuredtext-markup\n.. _PSF Code of Conduct: https://github.com/pypa/.github/blob/main/CODE_OF_CONDUCT.md\n\nCopyright \u00a9 2014, [The Python Packaging Authority].\n",
"bugtrack_url": null,
"license": "Apache License, Version 2.0",
"summary": "readme_renderer is a library for rendering readme descriptions for Warehouse",
"version": "43.0",
"project_urls": {
"Home-page": "https://github.com/pypa/readme_renderer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "45be3ea20dc38b9db08387cf97997a85a7d51527ea2057d71118feb0aa8afa55",
"md5": "86f6ff995c33b3e7bf1a82dc03e17ea5",
"sha256": "19db308d86ecd60e5affa3b2a98f017af384678c63c88e5d4556a380e674f3f9"
},
"downloads": -1,
"filename": "readme_renderer-43.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "86f6ff995c33b3e7bf1a82dc03e17ea5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 13301,
"upload_time": "2024-02-26T16:10:57",
"upload_time_iso_8601": "2024-02-26T16:10:57.945534Z",
"url": "https://files.pythonhosted.org/packages/45/be/3ea20dc38b9db08387cf97997a85a7d51527ea2057d71118feb0aa8afa55/readme_renderer-43.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "feb5536c775084d239df6345dccf9b043419c7e3308bc31be4c7882196abc62e",
"md5": "5fa2371162f5c0f5a3b8a880ae41b7be",
"sha256": "1818dd28140813509eeed8d62687f7cd4f7bad90d4db586001c5dc09d4fde311"
},
"downloads": -1,
"filename": "readme_renderer-43.0.tar.gz",
"has_sig": false,
"md5_digest": "5fa2371162f5c0f5a3b8a880ae41b7be",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 31768,
"upload_time": "2024-02-26T16:10:59",
"upload_time_iso_8601": "2024-02-26T16:10:59.415098Z",
"url": "https://files.pythonhosted.org/packages/fe/b5/536c775084d239df6345dccf9b043419c7e3308bc31be4c7882196abc62e/readme_renderer-43.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-26 16:10:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "pypa",
"github_project": "readme_renderer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "readme-renderer"
}
