| Name | readme-renderer JSON |
| Version |
44.0
JSON |
| download |
| home_page | None |
| Summary | readme_renderer is a library for rendering readme descriptions for Warehouse |
| upload_time | 2024-07-08 15:00:57 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| 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": null,
"name": "readme-renderer",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "The Python Packaging Authority <admin@mail.pypi.org>",
"download_url": "https://files.pythonhosted.org/packages/5a/a9/104ec9234c8448c4379768221ea6df01260cd6c2ce13182d4eac531c8342/readme_renderer-44.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": "44.0",
"project_urls": {
"Home-page": "https://github.com/pypa/readme_renderer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e167921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0",
"md5": "763b3f1823a569b7bdcb4b1a8a77f8e0",
"sha256": "2fbca89b81a08526aadf1357a8c2ae889ec05fb03f5da67f9769c9a592166151"
},
"downloads": -1,
"filename": "readme_renderer-44.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "763b3f1823a569b7bdcb4b1a8a77f8e0",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 13310,
"upload_time": "2024-07-08T15:00:56",
"upload_time_iso_8601": "2024-07-08T15:00:56.577790Z",
"url": "https://files.pythonhosted.org/packages/e1/67/921ec3024056483db83953ae8e48079ad62b92db7880013ca77632921dd0/readme_renderer-44.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5aa9104ec9234c8448c4379768221ea6df01260cd6c2ce13182d4eac531c8342",
"md5": "bcbb9d99a7b02379041044552f180c70",
"sha256": "8712034eabbfa6805cacf1402b4eeb2a73028f72d1166d6f5cb7f9c047c5d1e1"
},
"downloads": -1,
"filename": "readme_renderer-44.0.tar.gz",
"has_sig": false,
"md5_digest": "bcbb9d99a7b02379041044552f180c70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 32056,
"upload_time": "2024-07-08T15:00:57",
"upload_time_iso_8601": "2024-07-08T15:00:57.805068Z",
"url": "https://files.pythonhosted.org/packages/5a/a9/104ec9234c8448c4379768221ea6df01260cd6c2ce13182d4eac531c8342/readme_renderer-44.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-07-08 15:00:57",
"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"
}
