readme_renderer

Safely render long_description/README files in Warehouse

https://github.com/pypa/readme_renderer

Science Score: 23.0%

This score indicates how likely this project is to be science-related based on various indicators:

○
CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
○
.zenodo.json file
○
DOI references
○
Academic publication links
✓
Committers with academic emails
1 of 33 committers (3.0%) from academic institutions
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (6.8%) to scientific vocabulary

Keywords from Contributors

closember unit-testing property-based-testing fuzzing codeformatter autopep8 formatter gofmt pre-commit-hook yapf

Last synced: 6 months ago · JSON representation

Repository

Safely render long_description/README files in Warehouse

Basic Info

Host: GitHub
Owner: pypa
License: apache-2.0
Language: Python
Default Branch: main
Homepage:
Size: 308 KB

Statistics

Stars: 164
Watchers: 16
Forks: 92
Open Issues: 23
Releases: 29

Created almost 12 years ago · Last pushed about 1 year ago

Metadata Files

Readme Changelog License

README.rst

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].

Owner

Name: Python Packaging Authority
Login: pypa
Kind: organization
Email: info@pypa.io
Location: United States of America

Website: https://www.pypa.io
Repositories: 58
Profile: https://github.com/pypa

GitHub Events

Total

Watch event: 7
Issue comment event: 9
Push event: 1
Pull request review comment event: 3
Pull request review event: 4
Pull request event: 6
Fork event: 4

Last Year

Watch event: 7
Issue comment event: 9
Push event: 1
Pull request review comment event: 3
Pull request review event: 4
Pull request event: 6
Fork event: 4

Committers

Last synced: 8 months ago

All Time

Total Commits: 220
Total Committers: 33
Avg Commits per committer: 6.667
Development Distribution Score (DDS): 0.759

Past Year

Commits: 10
Committers: 2
Avg Commits per committer: 5.0
Development Distribution Score (DDS): 0.4

Top Committers

Name	Email	Commits
Dustin Ingram	di	53
Mike Fiedler	m**n@g**m	36
Donald Stufft	d**d@s**o	35
Jon Wayne Parrott	j**e@g**m	17
Marc Abramowitz	m**c@m**m	16
Kurt McKee	c**e@k**g	6
Michał Górny	m**y@g**g	5
Álvaro Mondéjar	m**4@g**m	5
Thea Flowers	t**s@g**m	4
Peter Shen	x**n@g**m	4
Thiago Colares	t**s@g**m	4
Chris Williams	c**s@g**m	4
Remi Rampin	r**n@g**m	3
Miloslav Pojman	m**n@g**m	3
Brian Rutledge	b**n@b**m	3
Till Hoffmann	t**n@g**m	2
Jon Dufresne	j**e@g**m	2
Benoit Pierre	b**e@g**m	2
Akash Mahanty	a**y@y**m	2
Anthony Sottile	a**e@u**u	1
Dominic Davis-Foster	d**c@d**k	1
Apurva Khatri	a**1@g**m	1
Alexander Lukanin	a**3@g**m	1
Ee Durbin	e**n@g**m	1
Florian Rathgeber	f**r@g**m	1
Floris Lambrechts	f**a@g**m	1
Hugo van Kemenade	h****k	1
Jannis Leidel	j**s@l**o	1
Marius Gedminas	m**s@g**s	1
Pradyun Gedam	p**g@g**m	1
and 3 more...

Committer Domains (Top 20 + Academic)

google.com: 2 suse.com: 1 freecog.net: 1 changeset.nyc: 1 gedmin.as: 1 leidel.info: 1 davis-foster.co.uk: 1 umich.edu: 1 bhrutledge.com: 1 gentoo.org: 1 kurtmckee.org: 1 marc-abramowitz.com: 1 stufft.io: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time

Total issues: 62
Total pull requests: 90
Average time to close issues: about 1 year
Average time to close pull requests: 3 months
Total issue authors: 49
Total pull request authors: 25
Average comments per issue: 3.5
Average comments per pull request: 1.02
Merged pull requests: 73
Bot issues: 0
Bot pull requests: 0

Past Year

Issues: 2
Pull requests: 8
Average time to close issues: N/A
Average time to close pull requests: 12 days
Issue authors: 2
Pull request authors: 4
Average comments per issue: 1.0
Average comments per pull request: 1.0
Merged pull requests: 3
Bot issues: 0
Bot pull requests: 0

View more stats

Top Authors

Issue Authors

miketheman (7)
di (5)
jwodder (2)
bhrutledge (2)
mweinelt (2)
billop (1)
davidam (1)
shahind (1)
schlatterbeck (1)
sergei-maertens (1)
nieder (1)
kif (1)
marian-code (1)
Julian (1)
buhtz (1)

Pull Request Authors

miketheman (37)
kurtmckee (15)
shenxianpeng (9)
mistwire (7)
di (6)
bhrutledge (3)
mondeja (3)
domdfcoding (2)
benoit-pierre (2)
verhovsky (2)
dstufft (1)
msabramo (1)
akamhy (1)
tillahoffmann (1)
danigm (1)

Top Labels

Issue Labels

enhancement (16) bug (10) good first issue (6) help wanted (4) question (3) needs clarification (2) feature request (2) invalid (1)

Pull Request Labels

enhancement (6) bug (1)

Packages

Total packages: 21
Total downloads:
- pypi 20,675,858 last-month
Total docker downloads: 858,602,718

Total dependent packages: 963
(may contain duplicates)
Total dependent repositories: 10,038
(may contain duplicates)
Total versions: 79
Total maintainers: 6

pypi.org: readme-renderer

readme_renderer is a library for rendering readme descriptions for Warehouse

Documentation: https://readme-renderer.readthedocs.io/
License: Apache License, Version 2.0
Latest release: 0.7.0
published about 10 years ago

Versions: 36
Dependent Packages: 956
Dependent Repositories: 10,002
Downloads: 20,675,858 Last month
Docker Downloads: 858,602,718

Rankings

Dependent packages count: 0.1%

Dependent repos count: 0.1%

Downloads: 0.1%

Average: 0.1%

Docker downloads count: 0.3%

Maintainers (4)

dstufft jezdez theacodes miketheman

Last synced: 6 months ago

alpine-v3.18: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 37.3-r1
published almost 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 7.3%

Forks count: 11.7%

Stargazers count: 17.5%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.18: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 37.3-r1
published almost 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 7.3%

Forks count: 11.7%

Stargazers count: 17.5%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.13: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 28.0-r0
published over 5 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 7.7%

Average: 9.5%

Stargazers count: 10.6%

Dependent packages count: 19.5%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.14: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 29.0-r1
published almost 5 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 7.9%

Average: 10.1%

Stargazers count: 10.9%

Dependent packages count: 21.7%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

spack.io: py-readme-renderer

readme_renderer is a library for rendering "readme" descriptions for Warehouse.

Homepage: https://github.com/pypa/readme_renderer
License: []
Latest release: 37.3
published about 3 years ago

Versions: 3
Dependent Packages: 2
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 10.8%

Average: 11.4%

Stargazers count: 15.9%

Dependent packages count: 19.0%

Maintainers (1)

adamjstewart

Last synced: 6 months ago

alpine-edge: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published over 1 year ago

Versions: 6
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Average: 11.5%

Forks count: 12.4%

Dependent packages count: 14.6%

Stargazers count: 18.8%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.15: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 29.0-r1
published almost 5 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 8.5%

Average: 11.5%

Stargazers count: 12.0%

Dependent packages count: 25.6%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-edge: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published over 1 year ago

Versions: 5
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Average: 11.7%

Forks count: 12.9%

Dependent packages count: 14.1%

Stargazers count: 19.7%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.16: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 29.0-r2
published about 4 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 9.0%

Average: 12.4%

Stargazers count: 13.1%

Dependent packages count: 27.3%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.17: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 37.1-r0
published over 3 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Forks count: 10.8%

Average: 13.5%

Stargazers count: 15.8%

Dependent packages count: 27.3%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

conda-forge.org: readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 37.3
published over 3 years ago

Versions: 11
Dependent Packages: 4
Dependent Repositories: 18

Rankings

Dependent repos count: 8.4%

Dependent packages count: 12.5%

Average: 17.4%

Forks count: 18.6%

Stargazers count: 30.0%

Last synced: 6 months ago

anaconda.org: readme_renderer

readme_renderer is a library for rendering readme descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 40.0
published over 2 years ago

Versions: 3
Dependent Packages: 1
Dependent Repositories: 18

Rankings

Dependent packages count: 30.7%

Forks count: 30.9%

Dependent repos count: 32.8%

Average: 33.8%

Stargazers count: 40.9%

Last synced: 6 months ago

alpine-v3.20: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 42.0-r1
published almost 2 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.21: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.22: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published 10 months ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.22: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published 10 months ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.19: py3-readme_renderer

readme_renderer is a library for rendering README descriptions for Warehouse

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 40.0-r0
published over 2 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Last synced: 6 months ago

alpine-v3.21: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 44.0-r0
published over 1 year ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

alpine-v3.19: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 40.0-r0
published over 2 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Last synced: 6 months ago

alpine-v3.20: py3-readme_renderer-pyc

Precompiled Python bytecode for py3-readme_renderer

Homepage: https://github.com/pypa/readme_renderer
License: Apache-2.0
Latest release: 42.0-r1
published almost 2 years ago

Versions: 1
Dependent Packages: 0
Dependent Repositories: 0

Rankings

Dependent repos count: 0.0%

Dependent packages count: 0.0%

Average: 100%

Maintainers (1)

bribbers@disroot.org

Last synced: 6 months ago

Dependencies

.github/workflows/ci.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite

.github/workflows/release.yml actions

actions/checkout v3 composite
actions/setup-python v4 composite
pypa/gh-action-pypi-publish release/v1 composite

pyproject.toml pypi

Pygments >=2.5.1
docutils >=0.13.1
nh3 >=0.2.14