← Back to branch summary

~ubuntu-branches/debian/sid/python-readme-renderer/sid

« back to all changes in this revision

Viewing changes to readme_renderer.egg-info/PKG-INFO

  • Committer: Package Import Robot
  • Author(s): Nicolas Dandrimont
  • Date: 2018-04-27 12:38:48 UTC
  • Revision ID: package-import@ubuntu.com-20180427123848-bon7mwqzv7steqri
Tags: upstream-20.0
Import upstream version 20.0

Show diffs side-by-side

added added

removed removed

Lines of Context:
readme_renderer.egg-info/PKG-INFO
 
1
Metadata-Version: 1.1
 
2
Name: readme-renderer
 
3
Version: 20.0
 
4
Summary: readme_renderer is a library for rendering "readme" descriptions for Warehouse
 
5
Home-page: https://github.com/pypa/readme_renderer
 
6
Author: The Python Packaging Authority
 
7
Author-email: admin@mail.pypi.org
 
8
License: Apache License, Version 2.0
 
9
Description-Content-Type: UNKNOWN
 
10
Description: Readme Renderer
 
11
        ===============
 
12
        
 
13
        Readme Renderer is a library that will safely render arbitrary
 
14
        ``README`` files into HTML. It is designed to be used in Warehouse_ to
 
15
        render the ``long_description`` for packages. It can handle Markdown,
 
16
        reStructuredText (``.rst``), and plain text.
 
17
        
 
18
        .. _Warehouse: https://github.com/pypa/warehouse
 
19
        
 
20
        
 
21
        Check Description Locally
 
22
        -------------------------
 
23
        
 
24
        reStructuredText
 
25
        ~~~~~~~~~~~~~~~~
 
26
        
 
27
        To locally check whether your reStructuredText long descriptions will render on
 
28
        PyPI, simply install the ``readme_renderer`` library using:
 
29
        
 
30
        .. code-block:: console
 
31
        
 
32
            $ pip install readme_renderer
 
33
            $ python setup.py check -r -s
 
34
            running check
 
35
        
 
36
        If there's a problem rendering your ``long_description``, the check
 
37
        will tell you. If your ``long_description`` is fine, you'll get no
 
38
        output.
 
39
        
 
40
        
 
41
        Markdown
 
42
        ~~~~~~~~
 
43
        
 
44
        Checking your Markdown long descriptions is unecessary, because unlike rST,
 
45
        where a properly rendered description is all-or-nothing, PyPI will still render
 
46
        your Markdown description as Markdown if it has some invalid or incorrect
 
47
        syntax.
 
48
        
 
49
        
 
50
        Code of Conduct
 
51
        ---------------
 
52
        
 
53
        Everyone interacting in the readme_renderer project's codebases, issue trackers,
 
54
        chat rooms, and mailing lists is expected to follow the `PyPA Code of Conduct`_.
 
55
        
 
56
        .. _PyPA Code of Conduct: https://www.pypa.io/en/latest/code-of-conduct/
 
57
        
 
58
Platform: UNKNOWN
 
59
Classifier: Intended Audience :: Developers
 
60
Classifier: License :: OSI Approved :: Apache Software License
 
61
Classifier: Natural Language :: English
 
62
Classifier: Operating System :: MacOS :: MacOS X
 
63
Classifier: Operating System :: POSIX
 
64
Classifier: Operating System :: POSIX :: BSD
 
65
Classifier: Operating System :: POSIX :: Linux
 
66
Classifier: Operating System :: Microsoft :: Windows
 
67
Classifier: Programming Language :: Python
 
68
Classifier: Programming Language :: Python :: 2
 
69
Classifier: Programming Language :: Python :: 2.7
 
70
Classifier: Programming Language :: Python :: 3
 
71
Classifier: Programming Language :: Python :: 3.4
 
72
Classifier: Programming Language :: Python :: 3.5
 
73
Classifier: Programming Language :: Python :: 3.6
 
74
Classifier: Programming Language :: Python :: Implementation :: CPython
 
75
Classifier: Programming Language :: Python :: Implementation :: PyPy