pax_global_header 0000666 0000000 0000000 00000000064 14212726341 0014514 g ustar 00root root 0000000 0000000 52 comment=4d4a8c60d18bb1ae30c212540e427b801302a052
readme_renderer-34.0/ 0000775 0000000 0000000 00000000000 14212726341 0014565 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/.coveragerc 0000664 0000000 0000000 00000000024 14212726341 0016702 0 ustar 00root root 0000000 0000000 [run]
branch = True
readme_renderer-34.0/.github/ 0000775 0000000 0000000 00000000000 14212726341 0016125 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/.github/workflows/ 0000775 0000000 0000000 00000000000 14212726341 0020162 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/.github/workflows/ci.yml 0000664 0000000 0000000 00000002566 14212726341 0021311 0 ustar 00root root 0000000 0000000 name: CI
on: [push, pull_request]
jobs:
test:
name: Test - ${{ matrix.python-version }}
runs-on: ubuntu-latest
strategy:
matrix:
python-version: ["pypy3", "3.6", "3.7", "3.8", "3.9", "3.10"]
steps:
- name: Check out repository
uses: actions/checkout@v2
- name: Install Python
uses: actions/setup-python@v2
with:
python-version: ${{ matrix.python-version }}
- name: Install dependencies
run: python -m pip install tox
- name: Run tests
run: python -m tox -e py
lint:
name: Lint
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v1
- name: Install Python
uses: actions/setup-python@v2
with:
python-version: "3.x"
- name: Install dependencies
run: python -m pip install tox
- name: Run linting
run: python -m tox -e pep8
- name: Run mypy
run: python -m tox -e mypy
packaging:
name: Packaging
runs-on: ubuntu-latest
steps:
- name: Check out repository
uses: actions/checkout@v1
- name: Install Python
uses: actions/setup-python@v2
with:
python-version: "3.x"
- name: Install dependencies
run: python -m pip install tox
- name: Test packaging
run: python -m tox -e packaging
readme_renderer-34.0/.github/workflows/release.yml 0000664 0000000 0000000 00000001057 14212726341 0022330 0 ustar 00root root 0000000 0000000 name: Release
on:
release:
types: [published]
jobs:
build-and-publish:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v2
with:
ref: ${{ github.event.release.tag_name }}
- name: Set up Python
uses: actions/setup-python@v2
- name: Install build dependencies
run: pip install -U setuptools wheel build
- name: Build
run: python -m build .
- name: Publish
uses: pypa/gh-action-pypi-publish@release/v1
with:
password: ${{ secrets.pypi_password }}
readme_renderer-34.0/.gitignore 0000664 0000000 0000000 00000000175 14212726341 0016560 0 ustar 00root root 0000000 0000000 __pycache__/
_build/
build/
dist/
htmlcov/
.tox/
.cache/
.coverage
*.egg-info/
*.egg
*.eggs
*.py[co]
.pytest_cache/
.idea/
readme_renderer-34.0/CHANGES.rst 0000664 0000000 0000000 00000007312 14212726341 0016372 0 ustar 00root root 0000000 0000000 Changes
=======
34.0 (2022-03-11)
-----------------
* Add static types (#225)
33.0 (2022-03-05)
-----------------
* Support cmarkgfm>=0.8.0 (#224)
33.0 (2022-02-05)
-----------------
* Support cmarkgfm>=0.8.0 (#224)
* Support Python 3.10
32.0 (2021-12-13)
-----------------
* Allow start attribute in ordered lists (#216)
* No limit rendering RST one column field names (#219)
31.0 (2021-12-09)
-----------------
* Render disabled checkboxes from Markdown (#217)
30.0 (2021-09-30)
-----------------
* support cmarkgfm>=0.6.0 (#209)
29.0 (2021-02-22)
-----------------
* Support cmarkgfm>=0.5.0 (#180)
* Drop support for Python 2 and 3.5 (#188)
28.0 (2020-10-20)
-----------------
* Support Python 3.9
27.0 (2020-10-09)
-----------------
* Add support for align attribute rendering Markdown headers (#173)
26.0 (2020-04-22)
-----------------
* Fix regression with image width/height attributes (#164)
25.0 (2020-03-14)
-----------------
* Support Python 3.7 and 3.8
* Drop support for Python 3.4
* Require Pygments>=2.5.1
24.0 (2018-10-27)
-----------------
* Remove dependency on ``future``. (#134)
23.0 (2018-10-22)
-----------------
* Breaking change: Move the cmarkgfm dependency into an extra (#130). Users
that want to render Markdown will need to install readme_render[md] instead.
22.0 (2018-09-17)
-----------------
* Unify handling of SVG and other images in RST. (#113)
* Support width and alignment of images in RST (#114)
21.0 (2018-05-28)
-----------------
* Allow
. (#105)
* Add specific tests for the raw directive. (#103)
* Include docinfo when rendering rst. (#99)
* Make Python 3 the default lexer for highlighting Python code in Markdown (#97)
* Allow align attribute on tags (#98)
20.0 (2018-04-13)
-----------------
* Reformat docutils messages into more human-friendly output. (#92)
* Fix incorrect escaping of html entities in pre tags when using markdown. (#89)
* Allow width, height, alt, and align attributes on img tags. (#91)
* Fix check to not report success when there is invalid RST. (#90)
19.0 (2018-04-10)
-----------------
* Allow details and summary tags. (#77)
* Add .pytest_cache to .gitignore. (#85)
* Warn about Markdown content type when checking RST. (#83)
* Update pep8 tox env to use py3.6. (#84)
* Add Pygments-based syntax highlighting for Markdown. (#82)
* Update docs about check to talk about Markdown. (#80)
18.1 (2018-04-01)
-----------------
* Change Github-flavored Markdown identifier from ``gfm`` to ``GFM``.
18.0 (2018-03-30)
-----------------
* Add support for GitHub-flavored Markdown. (#67)
* Switch to cmarkgfm completely for rendering Markdown. (#68)
* Warn about missing long description. (#69)
* Make Github-Flavored Markdown the default variant (#73)
17.4 (2018-03-16)
-----------------
* All renderers now accept arbitrary ``kwargs`` for future-proofing.
17.3 (2018-03-08)
-----------------
* Gracefully handle new exceptions from bleach.
17.2 (2017-03-11)
-----------------
* Fix an issue cleaning plaintext values.
17.1 (2017-03-09)
-----------------
* Fix an issue attempting to clean data that had ```` tags without a href.
17.0 (2017-03-08)
-----------------
* Fix issue with bleach >= 2.0.
16.0 (2016-12-09)
-----------------
* Fix issue with docutils >= 0.13.1.
0.7.0 (2016-01-04)
------------------
* Renamed to ``readme_renderer``: https://github.com/pypa/readme_renderer
to work around an name overlap with ``README`` files shipped in Python's
default site-packages directory on certain case-insensitive file systems.
* Added `PyPA Code of Conduct`_.
* Allow and tags when cleaning rST HTML output.
* Dropped support for Python 2.6.
.. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
readme_renderer-34.0/LICENSE 0000664 0000000 0000000 00000022736 14212726341 0015604 0 ustar 00root root 0000000 0000000 Apache License
Version 2.0, January 2004
http://www.apache.org/licenses/
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
1. Definitions.
"License" shall mean the terms and conditions for use, reproduction,
and distribution as defined by Sections 1 through 9 of this document.
"Licensor" shall mean the copyright owner or entity authorized by
the copyright owner that is granting the License.
"Legal Entity" shall mean the union of the acting entity and all
other entities that control, are controlled by, or are under common
control with that entity. For the purposes of this definition,
"control" means (i) the power, direct or indirect, to cause the
direction or management of such entity, whether by contract or
otherwise, or (ii) ownership of fifty percent (50%) or more of the
outstanding shares, or (iii) beneficial ownership of such entity.
"You" (or "Your") shall mean an individual or Legal Entity
exercising permissions granted by this License.
"Source" form shall mean the preferred form for making modifications,
including but not limited to software source code, documentation
source, and configuration files.
"Object" form shall mean any form resulting from mechanical
transformation or translation of a Source form, including but
not limited to compiled object code, generated documentation,
and conversions to other media types.
"Work" shall mean the work of authorship, whether in Source or
Object form, made available under the License, as indicated by a
copyright notice that is included in or attached to the work
(an example is provided in the Appendix below).
"Derivative Works" shall mean any work, whether in Source or Object
form, that is based on (or derived from) the Work and for which the
editorial revisions, annotations, elaborations, or other modifications
represent, as a whole, an original work of authorship. For the purposes
of this License, Derivative Works shall not include works that remain
separable from, or merely link (or bind by name) to the interfaces of,
the Work and Derivative Works thereof.
"Contribution" shall mean any work of authorship, including
the original version of the Work and any modifications or additions
to that Work or Derivative Works thereof, that is intentionally
submitted to Licensor for inclusion in the Work by the copyright owner
or by an individual or Legal Entity authorized to submit on behalf of
the copyright owner. For the purposes of this definition, "submitted"
means any form of electronic, verbal, or written communication sent
to the Licensor or its representatives, including but not limited to
communication on electronic mailing lists, source code control systems,
and issue tracking systems that are managed by, or on behalf of, the
Licensor for the purpose of discussing and improving the Work, but
excluding communication that is conspicuously marked or otherwise
designated in writing by the copyright owner as "Not a Contribution."
"Contributor" shall mean Licensor and any individual or Legal Entity
on behalf of whom a Contribution has been received by Licensor and
subsequently incorporated within the Work.
2. Grant of Copyright License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
copyright license to reproduce, prepare Derivative Works of,
publicly display, publicly perform, sublicense, and distribute the
Work and such Derivative Works in Source or Object form.
3. Grant of Patent License. Subject to the terms and conditions of
this License, each Contributor hereby grants to You a perpetual,
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
(except as stated in this section) patent license to make, have made,
use, offer to sell, sell, import, and otherwise transfer the Work,
where such license applies only to those patent claims licensable
by such Contributor that are necessarily infringed by their
Contribution(s) alone or by combination of their Contribution(s)
with the Work to which such Contribution(s) was submitted. If You
institute patent litigation against any entity (including a
cross-claim or counterclaim in a lawsuit) alleging that the Work
or a Contribution incorporated within the Work constitutes direct
or contributory patent infringement, then any patent licenses
granted to You under this License for that Work shall terminate
as of the date such litigation is filed.
4. Redistribution. You may reproduce and distribute copies of the
Work or Derivative Works thereof in any medium, with or without
modifications, and in Source or Object form, provided that You
meet the following conditions:
(a) You must give any other recipients of the Work or
Derivative Works a copy of this License; and
(b) You must cause any modified files to carry prominent notices
stating that You changed the files; and
(c) You must retain, in the Source form of any Derivative Works
that You distribute, all copyright, patent, trademark, and
attribution notices from the Source form of the Work,
excluding those notices that do not pertain to any part of
the Derivative Works; and
(d) If the Work includes a "NOTICE" text file as part of its
distribution, then any Derivative Works that You distribute must
include a readable copy of the attribution notices contained
within such NOTICE file, excluding those notices that do not
pertain to any part of the Derivative Works, in at least one
of the following places: within a NOTICE text file distributed
as part of the Derivative Works; within the Source form or
documentation, if provided along with the Derivative Works; or,
within a display generated by the Derivative Works, if and
wherever such third-party notices normally appear. The contents
of the NOTICE file are for informational purposes only and
do not modify the License. You may add Your own attribution
notices within Derivative Works that You distribute, alongside
or as an addendum to the NOTICE text from the Work, provided
that such additional attribution notices cannot be construed
as modifying the License.
You may add Your own copyright statement to Your modifications and
may provide additional or different license terms and conditions
for use, reproduction, or distribution of Your modifications, or
for any such Derivative Works as a whole, provided Your use,
reproduction, and distribution of the Work otherwise complies with
the conditions stated in this License.
5. Submission of Contributions. Unless You explicitly state otherwise,
any Contribution intentionally submitted for inclusion in the Work
by You to the Licensor shall be under the terms and conditions of
this License, without any additional terms or conditions.
Notwithstanding the above, nothing herein shall supersede or modify
the terms of any separate license agreement you may have executed
with Licensor regarding such Contributions.
6. Trademarks. This License does not grant permission to use the trade
names, trademarks, service marks, or product names of the Licensor,
except as required for reasonable and customary use in describing the
origin of the Work and reproducing the content of the NOTICE file.
7. Disclaimer of Warranty. Unless required by applicable law or
agreed to in writing, Licensor provides the Work (and each
Contributor provides its Contributions) on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
implied, including, without limitation, any warranties or conditions
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
PARTICULAR PURPOSE. You are solely responsible for determining the
appropriateness of using or redistributing the Work and assume any
risks associated with Your exercise of permissions under this License.
8. Limitation of Liability. In no event and under no legal theory,
whether in tort (including negligence), contract, or otherwise,
unless required by applicable law (such as deliberate and grossly
negligent acts) or agreed to in writing, shall any Contributor be
liable to You for damages, including any direct, indirect, special,
incidental, or consequential damages of any character arising as a
result of this License or out of the use or inability to use the
Work (including but not limited to damages for loss of goodwill,
work stoppage, computer failure or malfunction, or any and all
other commercial damages or losses), even if such Contributor
has been advised of the possibility of such damages.
9. Accepting Warranty or Additional Liability. While redistributing
the Work or Derivative Works thereof, You may choose to offer,
and charge a fee for, acceptance of support, warranty, indemnity,
or other liability obligations and/or rights consistent with this
License. However, in accepting such obligations, You may act only
on Your own behalf and on Your sole responsibility, not on behalf
of any other Contributor, and only if You agree to indemnify,
defend, and hold each Contributor harmless for any liability
incurred by, or claims asserted against, such Contributor by reason
of your accepting any such warranty or additional liability.
readme_renderer-34.0/MANIFEST.in 0000664 0000000 0000000 00000000405 14212726341 0016322 0 ustar 00root root 0000000 0000000 include LICENSE README.rst CHANGES.rst
include tox.ini .coveragerc pytest.ini
include readme_renderer/py.typed
recursive-include tests *.html
recursive-include tests *.py
recursive-include tests *.rst
recursive-include tests *.txt
recursive-include tests *.md
readme_renderer-34.0/README.rst 0000664 0000000 0000000 00000002254 14212726341 0016257 0 ustar 00root root 0000000 0000000 Readme Renderer
===============
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.
Render rST Description Locally
------------------------------
You can use ``readme_renderer`` on the command line to render an rST file as
HTML like this: ::
python -m readme_renderer README.rst -o /tmp/README.html
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
readme_renderer-34.0/pyproject.toml 0000664 0000000 0000000 00000000540 14212726341 0017500 0 ustar 00root root 0000000 0000000 [build-system]
requires = ["setuptools>=40.8.0", "wheel", "bleach>=2.1.0", "docutils>=0.13.1", "Pygments>=2.5.1"]
build-backend = "setuptools.build_meta:__legacy__"
[tool.mypy]
strict = true
warn_unused_configs = true
[[tool.mypy.overrides]]
# These modules do not yet have types available.
module = [
"cmarkgfm.*"
]
ignore_missing_imports = true
readme_renderer-34.0/pytest.ini 0000664 0000000 0000000 00000000147 14212726341 0016620 0 ustar 00root root 0000000 0000000 [pytest]
markers =
filterwarnings: built-in maker to silence warnings, not recognized by --strict.
readme_renderer-34.0/readme_renderer/ 0000775 0000000 0000000 00000000000 14212726341 0017710 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/readme_renderer/__about__.py 0000664 0000000 0000000 00000002240 14212726341 0022166 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
__all__ = [
"__title__",
"__summary__",
"__uri__",
"__version__",
"__author__",
"__email__",
"__license__",
"__copyright__",
]
__title__ = "readme_renderer"
__summary__ = (
'readme_renderer is a library for rendering "readme" ' "descriptions for Warehouse"
)
__uri__ = "https://github.com/pypa/readme_renderer"
__version__ = "34.0"
__author__ = "The Python Packaging Authority"
__email__ = "admin@mail.pypi.org"
__license__ = "Apache License, Version 2.0"
__copyright__ = "Copyright 2014 %s" % __author__
readme_renderer-34.0/readme_renderer/__init__.py 0000664 0000000 0000000 00000001176 14212726341 0022026 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
readme_renderer-34.0/readme_renderer/__main__.py 0000664 0000000 0000000 00000001250 14212726341 0022000 0 ustar 00root root 0000000 0000000 from __future__ import absolute_import, print_function
import argparse
from readme_renderer.rst import render
import sys
if __name__ == '__main__':
parser = argparse.ArgumentParser(
description="Renders a .rst README to HTML",
)
parser.add_argument('input', help="Input README file",
type=argparse.FileType('r'))
parser.add_argument('-o', '--output', help="Output file (default: stdout)",
type=argparse.FileType('w'), default='-')
args = parser.parse_args()
rendered = render(args.input.read(), stream=sys.stderr)
if rendered is None:
sys.exit(1)
print(rendered, file=args.output)
readme_renderer-34.0/readme_renderer/clean.py 0000664 0000000 0000000 00000007770 14212726341 0021357 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
import functools
from typing import Any, Dict, Iterator, List, Optional
import bleach
import bleach.callbacks
import bleach.linkifier
import bleach.sanitizer
ALLOWED_TAGS = [
# Bleach Defaults
"a", "abbr", "acronym", "b", "blockquote", "code", "em", "i", "li", "ol",
"strong", "ul",
# Custom Additions
"br", "caption", "cite", "col", "colgroup", "dd", "del", "details", "div",
"dl", "dt", "h1", "h2", "h3", "h4", "h5", "h6", "hr", "img", "p", "pre",
"span", "sub", "summary", "sup", "table", "tbody", "td", "th", "thead",
"tr", "tt", "kbd", "var", "input",
]
ALLOWED_ATTRIBUTES = {
# Bleach Defaults
"a": ["href", "title"],
"abbr": ["title"],
"acronym": ["title"],
# Custom Additions
"*": ["id"],
"hr": ["class"],
"img": ["src", "width", "height", "alt", "align", "class"],
"span": ["class"],
"th": ["align"],
"td": ["align"],
"div": ["align"],
"h1": ["align"],
"h2": ["align"],
"h3": ["align"],
"h4": ["align"],
"h5": ["align"],
"h6": ["align"],
"code": ["class"],
"p": ["align"],
"ol": ["start"],
"input": ["type", "checked", "disabled"],
}
class DisabledCheckboxInputsFilter:
# The typeshed for bleach (html5lib) filters is incomplete, use `typing.Any`
# See https://github.com/python/typeshed/blob/505ea726415016e53638c8b584b8fdc9c722cac1/stubs/bleach/bleach/html5lib_shim.pyi#L7-L8 # noqa E501
def __init__(self, source: Any) -> None:
self.source = source
def __iter__(self) -> Iterator[Dict[str, Optional[str]]]:
for token in self.source:
if token.get("name") == "input":
# only allow disabled checkbox inputs
is_checkbox, is_disabled, unsafe_attrs = False, False, False
for (_, attrname), value in token.get("data", {}).items():
if attrname == "type" and value == "checkbox":
is_checkbox = True
elif attrname == "disabled":
is_disabled = True
elif attrname != "checked":
unsafe_attrs = True
break
if is_checkbox and is_disabled and not unsafe_attrs:
yield token
else:
yield token
def __getattr__(self, name: str) -> Any:
return getattr(self.source, name)
def clean(
html: str,
tags: Optional[List[str]] = None,
attributes: Optional[Dict[str, List[str]]] = None
) -> Optional[str]:
if tags is None:
tags = ALLOWED_TAGS
if attributes is None:
attributes = ALLOWED_ATTRIBUTES
# Clean the output using Bleach
cleaner = bleach.sanitizer.Cleaner(
tags=tags,
attributes=attributes,
filters=[
# Bleach Linkify makes it easy to modify links, however, we will
# not be using it to create additional links.
functools.partial(
bleach.linkifier.LinkifyFilter,
callbacks=[
lambda attrs, new: attrs if not new else None,
bleach.callbacks.nofollow,
],
skip_tags=["pre"],
parse_email=False,
),
DisabledCheckboxInputsFilter,
],
)
try:
cleaned = cleaner.clean(html)
return cleaned
except ValueError:
return None
readme_renderer-34.0/readme_renderer/integration/ 0000775 0000000 0000000 00000000000 14212726341 0022233 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/readme_renderer/integration/__init__.py 0000664 0000000 0000000 00000001176 14212726341 0024351 0 ustar 00root root 0000000 0000000 # Copyright 2015 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
readme_renderer-34.0/readme_renderer/integration/distutils.py 0000664 0000000 0000000 00000007512 14212726341 0024636 0 ustar 00root root 0000000 0000000 # Copyright 2015 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# The `distutils` integration is going to need to get updated to `setuptools``
# soon enough, as `distutils` is deprecated and will be removed in Python 3.12.
# There's currently some pass-through imports that allow this to work, but is
# challenging for `mypy` in `strict` mode, so let's skip this file for now.
# See https://peps.python.org/pep-0632/
# mypy: ignore-errors
from __future__ import absolute_import, division, print_function
import cgi
import io
import re
import distutils.log
from distutils.command.check import check as _check
from distutils.core import Command
from ..rst import render
# Regular expression used to capture and reformat doctuils warnings into
# something that a human can understand. This is loosely borrowed from
# Sphinx: https://github.com/sphinx-doc/sphinx/blob
# /c35eb6fade7a3b4a6de4183d1dd4196f04a5edaf/sphinx/util/docutils.py#L199
_REPORT_RE = re.compile(
r'^:(?P(?:\d+)?): '
r'\((?PDEBUG|INFO|WARNING|ERROR|SEVERE)/(\d+)?\) '
r'(?P.*)', re.DOTALL | re.MULTILINE)
class _WarningStream(object):
def __init__(self):
self.output = io.StringIO()
def write(self, text):
matched = _REPORT_RE.search(text)
if not matched:
self.output.write(text)
return
self.output.write(
u"line {line}: {level_text}: {message}\n".format(
level_text=matched.group('level').capitalize(),
line=matched.group('line'),
message=matched.group('message').rstrip('\r\n')))
def __str__(self):
return self.output.getvalue()
class Check(_check):
def check_restructuredtext(self):
"""
Checks if the long string fields are reST-compliant.
"""
# Warn that this command is deprecated
# Don't use self.warn() because it will cause the check to fail.
Command.warn(
self,
"This command has been deprecated. Use `twine check` instead: "
"https://packaging.python.org/guides/making-a-pypi-friendly-readme"
"#validating-restructuredtext-markup"
)
data = self.distribution.get_long_description()
content_type = getattr(
self.distribution.metadata, 'long_description_content_type', None)
if content_type:
content_type, _ = cgi.parse_header(content_type)
if content_type != 'text/x-rst':
self.warn(
"Not checking long description content type '%s', this "
"command only checks 'text/x-rst'." % content_type)
return
# None or empty string should both trigger this branch.
if not data or data == 'UNKNOWN':
self.warn(
"The project's long_description is either missing or empty.")
return
stream = _WarningStream()
markup = render(data, stream=stream)
if markup is None:
self.warn(
"The project's long_description has invalid markup which will "
"not be rendered on PyPI. The following syntax errors were "
"detected:\n%s" % stream)
return
self.announce(
"The project's long description is valid RST.",
level=distutils.log.INFO)
readme_renderer-34.0/readme_renderer/markdown.py 0000664 0000000 0000000 00000007124 14212726341 0022110 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
import re
import warnings
from typing import Any, Match, Optional
from html import unescape
import pygments
import pygments.lexers
import pygments.formatters
from .clean import clean
_EXTRA_WARNING = (
"Markdown renderers are not available. "
"Install 'readme_renderer[md]' to enable Markdown rendering."
)
try:
import cmarkgfm
from cmarkgfm.cmark import Options as cmarkgfmOptions
variants = {
"GFM": lambda raw: cmarkgfm.github_flavored_markdown_to_html(
raw, options=cmarkgfmOptions.CMARK_OPT_UNSAFE
),
"CommonMark": lambda raw: cmarkgfm.markdown_to_html(
raw, options=cmarkgfmOptions.CMARK_OPT_UNSAFE
),
}
except ImportError:
warnings.warn(_EXTRA_WARNING)
variants = {}
# Make code fences with `python` as the language default to highlighting as
# Python 3.
_LANG_ALIASES = {
'python': 'python3',
}
def render(
raw: str,
variant: str = "GFM",
**kwargs: Any
) -> Optional[str]:
if not variants:
warnings.warn(_EXTRA_WARNING)
return None
renderer = variants.get(variant)
if not renderer:
return None
# The renderer is a lambda function, and mypy fails lambdas right now.
rendered = renderer(raw) # type: ignore
if not rendered:
return None
highlighted = _highlight(rendered)
cleaned = clean(highlighted)
return cleaned
def _highlight(html: str) -> str:
"""Syntax-highlights HTML-rendered Markdown.
Plucks sections to highlight that conform the the GitHub fenced code info
string as defined at https://github.github.com/gfm/#info-string.
Args:
html (str): The rendered HTML.
Returns:
str: The HTML with Pygments syntax highlighting applied to all code
blocks.
"""
formatter = pygments.formatters.HtmlFormatter(nowrap=True)
code_expr = re.compile(
# cmarkgfm<0.6.0: print('hello')
# cmarkgfm>=0.6.0: print('hello')
r'((?P[^"]+?)">'
'(?(in_code)|)(?P.+?)'
r'
', re.DOTALL)
def replacer(match: Match[Any]) -> str:
try:
lang = match.group('lang')
lang = _LANG_ALIASES.get(lang, lang)
lexer = pygments.lexers.get_lexer_by_name(lang)
except ValueError:
lexer = pygments.lexers.TextLexer()
code = match.group('code')
# Decode html entities in the code. cmark tries to be helpful and
# translate '"' to '"', but it confuses pygments. Pygments will
# escape any html entities when re-writing the code, and we run
# everything through bleach after.
code = unescape(code)
highlighted = pygments.highlight(code, lexer, formatter)
return '{} '.format(highlighted)
result = code_expr.sub(replacer, html)
return result
readme_renderer-34.0/readme_renderer/py.typed 0000664 0000000 0000000 00000000000 14212726341 0021375 0 ustar 00root root 0000000 0000000 readme_renderer-34.0/readme_renderer/rst.py 0000664 0000000 0000000 00000010313 14212726341 0021070 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
import io
from typing import Any, Dict, IO, Optional, Union
from docutils.core import publish_parts
from docutils.nodes import colspec, image
from docutils.writers.html4css1 import HTMLTranslator, Writer
from docutils.utils import SystemMessage
from .clean import clean
class ReadMeHTMLTranslator(HTMLTranslator): # type: ignore[misc] # docutils is incomplete, returns `Any` python/typeshed#7256 # noqa E501
# Overrides base class not to output `` tag for SVG images.
object_image_types: Dict[str, str] = {}
def emptytag(
self,
node: Union[colspec, image],
tagname: str,
suffix: str = "\n",
**attributes: Any
) -> Any:
"""Override this to add back the width/height attributes."""
if tagname == "img":
if "width" in node:
attributes["width"] = node["width"]
if "height" in node:
attributes["height"] = node["height"]
return super(ReadMeHTMLTranslator, self).emptytag(
node, tagname, suffix, **attributes
)
SETTINGS = {
# Cloaking email addresses provides a small amount of additional
# privacy protection for email addresses inside of a chunk of ReST.
"cloak_email_addresses": True,
# Prevent a lone top level heading from being promoted to document
# title, and thus second level headings from being promoted to top
# level.
"doctitle_xform": True,
# Prevent a lone subsection heading from being promoted to section
# title, and thus second level headings from being promoted to top
# level.
"sectsubtitle_xform": True,
# Set our initial header level
"initial_header_level": 2,
# Prevent local files from being included into the rendered output.
# This is a security concern because people can insert files
# that are part of the system, such as /etc/passwd.
"file_insertion_enabled": False,
# Halt rendering and throw an exception if there was any errors or
# warnings from docutils.
"halt_level": 2,
# Output math blocks as LaTeX that can be interpreted by MathJax for
# a prettier display of Math formulas.
"math_output": "MathJax",
# Disable raw html as enabling it is a security risk, we do not want
# people to be able to include any old HTML in the final output.
"raw_enabled": False,
# Disable all system messages from being reported.
"report_level": 5,
# Use typographic quotes, and transform --, ---, and ... into their
# typographic counterparts.
"smart_quotes": True,
# Strip all comments from the rendered output.
"strip_comments": True,
# Use the short form of syntax highlighting so that the generated
# Pygments CSS can be used to style the output.
"syntax_highlight": "short",
# Maximum width (in characters) for one-column field names.
# 0 means "no limit"
"field_name_limit": 0,
}
def render(
raw: str,
stream: Optional[IO[str]] = None,
**kwargs: Any
) -> Optional[str]:
if stream is None:
# Use a io.StringIO as the warning stream to prevent warnings from
# being printed to sys.stderr.
stream = io.StringIO()
settings = SETTINGS.copy()
settings["warning_stream"] = stream
writer = Writer()
writer.translator_class = ReadMeHTMLTranslator
try:
parts = publish_parts(raw, writer=writer, settings_overrides=settings)
except SystemMessage:
rendered = None
else:
rendered = parts.get("docinfo", "") + parts.get("fragment", "")
if rendered:
return clean(rendered)
else:
return None
readme_renderer-34.0/readme_renderer/txt.py 0000664 0000000 0000000 00000002032 14212726341 0021076 0 ustar 00root root 0000000 0000000 # Copyright 2015 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
import sys
from typing import Any, Optional
from .clean import clean
if sys.version_info >= (3,):
from html import escape as html_escape
else:
from cgi import escape
def html_escape(s):
return escape(s, quote=True).replace("'", ''')
def render(raw: str, **kwargs: Any) -> Optional[str]:
rendered = html_escape(raw).replace("\n", " ")
return clean(rendered, tags=["br"])
readme_renderer-34.0/setup.cfg 0000664 0000000 0000000 00000000042 14212726341 0016402 0 ustar 00root root 0000000 0000000 [metadata]
license_file = LICENSE
readme_renderer-34.0/setup.py 0000664 0000000 0000000 00000004636 14212726341 0016310 0 ustar 00root root 0000000 0000000 # Copyright 2014 Donald Stufft
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
# http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
from __future__ import absolute_import, division, print_function
import os
import setuptools
base_dir = os.path.dirname(__file__)
with open(os.path.join(base_dir, "readme_renderer", "__about__.py")) as f:
about = {}
exec(f.read(), about)
with open(os.path.join(base_dir, "README.rst")) as f:
long_description = f.read()
setuptools.setup(
name=about["__title__"],
version=about["__version__"],
description=about["__summary__"],
long_description=long_description,
license=about["__license__"],
url=about["__uri__"],
author=about["__author__"],
author_email=about["__email__"],
classifiers=[
"Intended Audience :: Developers",
"License :: OSI Approved :: Apache Software License",
"Natural Language :: English",
"Operating System :: MacOS :: MacOS X",
"Operating System :: POSIX",
"Operating System :: POSIX :: BSD",
"Operating System :: POSIX :: Linux",
"Operating System :: Microsoft :: Windows",
"Programming Language :: Python",
"Programming Language :: Python :: 3",
"Programming Language :: Python :: 3 :: Only",
"Programming Language :: Python :: 3.6",
"Programming Language :: Python :: 3.7",
"Programming Language :: Python :: 3.8",
"Programming Language :: Python :: 3.9",
"Programming Language :: Python :: 3.10",
"Programming Language :: Python :: Implementation :: CPython",
"Programming Language :: Python :: Implementation :: PyPy",
],
install_requires=["bleach>=2.1.0", "docutils>=0.13.1", "Pygments>=2.5.1"],
entry_points={
"distutils.commands": ["check = readme_renderer.integration.distutils:Check"],
},
extras_require={"md": "cmarkgfm>=0.8.0"},
packages=setuptools.find_packages(exclude=["tests", "tests.*"]),
python_requires=">=3.6",
)
readme_renderer-34.0/tests/ 0000775 0000000 0000000 00000000000 14212726341 0015727 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/tests/__init__.py 0000664 0000000 0000000 00000000000 14212726341 0020026 0 ustar 00root root 0000000 0000000 readme_renderer-34.0/tests/fixtures/ 0000775 0000000 0000000 00000000000 14212726341 0017600 5 ustar 00root root 0000000 0000000 readme_renderer-34.0/tests/fixtures/test_CommonMark_001.html 0000664 0000000 0000000 00000000015 14212726341 0024144 0 ustar 00root root 0000000 0000000 Hello
readme_renderer-34.0/tests/fixtures/test_CommonMark_001.md 0000664 0000000 0000000 00000000006 14212726341 0023600 0 ustar 00root root 0000000 0000000 Hello
readme_renderer-34.0/tests/fixtures/test_CommonMark_002.html 0000664 0000000 0000000 00000000043 14212726341 0024146 0 ustar 00root root 0000000 0000000 http://mymalicioussite.com/
readme_renderer-34.0/tests/fixtures/test_CommonMark_002.md 0000664 0000000 0000000 00000000034 14212726341 0023602 0 ustar 00root root 0000000 0000000 http://mymalicioussite.com/
readme_renderer-34.0/tests/fixtures/test_CommonMark_003.html 0000664 0000000 0000000 00000000242 14212726341 0024150 0 ustar 00root root 0000000 0000000 Required packages
To run the PyPI software, you need Python 2.5+ and PostgreSQL
Quick development setup
Make sure you are sitting
readme_renderer-34.0/tests/fixtures/test_CommonMark_003.md 0000664 0000000 0000000 00000000212 14212726341 0023601 0 ustar 00root root 0000000 0000000 ## Required packages
To run the PyPI software, you need Python 2.5+ and PostgreSQL
## Quick development setup
Make sure you are sitting
readme_renderer-34.0/tests/fixtures/test_CommonMark_004.html 0000664 0000000 0000000 00000000242 14212726341 0024151 0 ustar 00root root 0000000 0000000 Required packages
To run the PyPI software, you need Python 2.5+ and PostgreSQL
Quick development setup
Make sure you are sitting
readme_renderer-34.0/tests/fixtures/test_CommonMark_004.md 0000664 0000000 0000000 00000000241 14212726341 0023604 0 ustar 00root root 0000000 0000000 Required packages
To run the PyPI software, you need Python 2.5+ and PostgreSQL
Quick development setup
Make sure you are sitting