**DistInfo-ReadMe** is a Python library for postviewing the readme of installed
Python projects in a Python environment. The **DistInfo-ReadMe** package must be
installed in that Python environment. The readme, that is displayed on the project
page on `PyPI`__ under the heading *Project description*, is provided by the
*Description* field or by the message body in the ``METADATA`` file in the
``.dist-info`` directory. The ``.dist-info`` directory is located along-side the
importable modules and packages from the distribution of the installed project in
the ``site-packages`` directory.
__ https://pypi.org
**DistInfo-ReadMe** will render the readme to a temporary HTML file that will be
displayed in a webbrowser.
Before developers upload their distribution archives to the Python Package Index,
they can install the ``.whl`` file (built distribution), for example, in a test
virtual environment along-side the **DistInfo-ReadMe** package. With
**DistInfo-ReadMe** you can preview your readme.
Installation
------------
In any Python environment with pip::
> pip install DistInfo-ReadMe
Usage
-----
from console::
> distinfo_readme --help
usage: distinfo_readme [-h] [-V] [-b BROWSER_TYPE] [-t TIMEOUT] package
A postviewing of the readme of installed Python projects
positional arguments:
package name of installed package
options:
-h, --help show this help message and exit
-V, --version show program's version number and exit
-b BROWSER_TYPE, --browser-type BROWSER_TYPE
-t TIMEOUT, --timeout TIMEOUT
wait for webbrowser to open temporary HTML file (default 2 s)
> distinfo_readme DistInfo-ReadMe
Creating HTML file /tmp/tmpo0ppotys.html
> python -m distinfo_readme setuptools
Creating HTML file /tmp/tmprbzj6rz6.html
>
from Python console:
.. code-block:: pycon
Python 3.11.2 (main, Mar 22 2023, 14:25:44) [GCC 12.2.1 20230201] on linux
Type "help", "copyright", "credits" or "license" for more information.
>>> from distinfo_readme import *
>>> post_view('cmarkgfm')
Creating HTML file /tmp/tmp2mcl_o6f.html
>>>
Raw data
{
"_id": null,
"home_page": "",
"name": "DistInfo-ReadMe",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": ".dist-info,readme,metadata,viewing,site-packages,postview,preview,project,description,test",
"author": "Stephan Zevenhuizen",
"author_email": "S.J.M.Zevenhuizen@uu.nl",
"download_url": "https://files.pythonhosted.org/packages/73/ab/8ce970a59969236d22bbf49519b15131c667d89a35953e99abc22188ae31/DistInfo-ReadMe-1.0.0.tar.gz",
"platform": null,
"description": "**DistInfo-ReadMe** is a Python library for postviewing the readme of installed\nPython projects in a Python environment. The **DistInfo-ReadMe** package must be\ninstalled in that Python environment. The readme, that is displayed on the project\npage on `PyPI`__ under the heading *Project description*, is provided by the\n*Description* field or by the message body in the ``METADATA`` file in the\n``.dist-info`` directory. The ``.dist-info`` directory is located along-side the\nimportable modules and packages from the distribution of the installed project in\nthe ``site-packages`` directory.\n\n__ https://pypi.org\n\n**DistInfo-ReadMe** will render the readme to a temporary HTML file that will be\ndisplayed in a webbrowser.\nBefore developers upload their distribution archives to the Python Package Index,\nthey can install the ``.whl`` file (built distribution), for example, in a test\nvirtual environment along-side the **DistInfo-ReadMe** package. With\n**DistInfo-ReadMe** you can preview your readme.\n\nInstallation\n------------\nIn any Python environment with pip::\n\n > pip install DistInfo-ReadMe\n\nUsage\n-----\nfrom console::\n\n > distinfo_readme --help\n usage: distinfo_readme [-h] [-V] [-b BROWSER_TYPE] [-t TIMEOUT] package\n\n A postviewing of the readme of installed Python projects\n\n positional arguments:\n package name of installed package\n\n options:\n -h, --help show this help message and exit\n -V, --version show program's version number and exit\n -b BROWSER_TYPE, --browser-type BROWSER_TYPE\n -t TIMEOUT, --timeout TIMEOUT\n wait for webbrowser to open temporary HTML file (default 2 s)\n > distinfo_readme DistInfo-ReadMe\n Creating HTML file /tmp/tmpo0ppotys.html\n > python -m distinfo_readme setuptools\n Creating HTML file /tmp/tmprbzj6rz6.html\n > \n\nfrom Python console:\n\n.. code-block:: pycon\n\n Python 3.11.2 (main, Mar 22 2023, 14:25:44) [GCC 12.2.1 20230201] on linux\n Type \"help\", \"copyright\", \"credits\" or \"license\" for more information.\n >>> from distinfo_readme import *\n >>> post_view('cmarkgfm')\n Creating HTML file /tmp/tmp2mcl_o6f.html\n >>> \n",
"bugtrack_url": null,
"license": "BSD-2-Clause",
"summary": "A postviewing of the readme of installed Python projects",
"version": "1.0.0",
"project_urls": null,
"split_keywords": [
".dist-info",
"readme",
"metadata",
"viewing",
"site-packages",
"postview",
"preview",
"project",
"description",
"test"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "79157f77b939f800e22fadcc9a38fe8e397121d43e6af670571218a97aa8e238",
"md5": "70a8c8a2d353e29761fc12db90f432e9",
"sha256": "7aa40b9f19e9ba526b4252c451caa266088aa2e01fdab9169c9bf3f6cbcf2a13"
},
"downloads": -1,
"filename": "DistInfo_ReadMe-1.0.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "70a8c8a2d353e29761fc12db90f432e9",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 23017,
"upload_time": "2023-08-04T10:06:00",
"upload_time_iso_8601": "2023-08-04T10:06:00.042028Z",
"url": "https://files.pythonhosted.org/packages/79/15/7f77b939f800e22fadcc9a38fe8e397121d43e6af670571218a97aa8e238/DistInfo_ReadMe-1.0.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "73ab8ce970a59969236d22bbf49519b15131c667d89a35953e99abc22188ae31",
"md5": "5526e66b5dbb55162f023f89daac853a",
"sha256": "73889cb27b91db1f0d9430c5b6f643873414b9ceefe2f5d1d85ac258be651d44"
},
"downloads": -1,
"filename": "DistInfo-ReadMe-1.0.0.tar.gz",
"has_sig": false,
"md5_digest": "5526e66b5dbb55162f023f89daac853a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 22363,
"upload_time": "2023-08-04T10:06:02",
"upload_time_iso_8601": "2023-08-04T10:06:02.063466Z",
"url": "https://files.pythonhosted.org/packages/73/ab/8ce970a59969236d22bbf49519b15131c667d89a35953e99abc22188ae31/DistInfo-ReadMe-1.0.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-08-04 10:06:02",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "distinfo-readme"
}
JSON