From add3e836f537e0220518c358dca8f32a03ab4d40 Mon Sep 17 00:00:00 2001 From: Johnson Date: Sun, 19 Sep 2021 09:36:30 +0800 Subject: [PATCH] Add more descriptions --- README.md | 7 ++++++- docs/pages/changelog.rst | 2 +- setup.py | 19 +++++++++++++++---- 3 files changed, 22 insertions(+), 6 deletions(-) diff --git a/README.md b/README.md index 5dafadf..8e0e72e 100644 --- a/README.md +++ b/README.md @@ -2,6 +2,9 @@ [![tests](https://github.com/j3soon/tbparse/actions/workflows/test-with-tox.yaml/badge.svg?branch=master&event=push)](https://github.com/j3soon/tbparse/actions/workflows/test-with-tox.yaml) [![build](https://github.com/j3soon/tbparse/actions/workflows/publish-to-pypi.yaml/badge.svg)](https://github.com/j3soon/tbparse/actions/workflows/publish-to-pypi.yaml) +[![doc](https://readthedocs.org/projects/tbparse/badge/?version=latest)](https://tbparse.readthedocs.io/en/latest/?badge=latest) +[![pypi](https://img.shields.io/pypi/v/tbparse)](https://pypi.org/project/tbparse/) +[![python](https://img.shields.io/pypi/pyversions/tbparse)](https://pypi.org/project/tbparse/) Read, parse, and plot tensorboard event logs with ease! @@ -9,7 +12,9 @@ tbparse is a simple parser for reading tensorboard logs. It supports logs genera Currently, tbparse enables parsing native types (scalars, tensors, histograms, etc.) easily. More event types will be supported in future versions. -![preview](docs/images/preview.png) +See [the Documentation](https://tbparse.readthedocs.io) for usage details and API reference. + +![](docs/images/preview.png) ## Installation diff --git a/docs/pages/changelog.rst b/docs/pages/changelog.rst index d85cea2..1a633d3 100644 --- a/docs/pages/changelog.rst +++ b/docs/pages/changelog.rst @@ -7,7 +7,7 @@ v0.0.2 Fixes: -* Fix PyPI release issue +* Fix PyPI packaging issue v0.0.1 =================================== diff --git a/setup.py b/setup.py index 4a43342..0cc3f94 100644 --- a/setup.py +++ b/setup.py @@ -3,20 +3,31 @@ with open("README.md", "r", encoding="utf-8") as fh: long_description = fh.read() +github_url = "https://github.com/j3soon/tbparse" + setuptools.setup( name="tbparse", version="0.0.2", author="Johnson", author_email="j3.soon@msa.hinet.net", - description="A simple parser for reading tensorboard logs", + description="Read, parse, and plot tensorboard event logs with ease!", long_description=long_description, long_description_content_type="text/markdown", - url="https://github.com/j3soon/tbparse", + url=github_url, project_urls={ - "Bug Tracker": "https://github.com/j3soon/tbparse/issues", + 'Changelog': f'{github_url}/blob/master/docs/pages/changelog.rst', + 'Issues': f'{github_url}/issues', + 'Source Code': github_url, }, + keywords=( + 'package, parser, plot, python, pytorch, reader, tensorboard, tensorboardx, tensorflow' + ), classifiers=[ - "Programming Language :: Python :: 3", + 'Development Status :: 4 - Beta', + 'Intended Audience :: Science/Research', + 'Programming Language :: Python :: 3.7', + 'Programming Language :: Python :: 3.8', + 'Programming Language :: Python :: 3.9', "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", ],