diff --git a/README.md b/README.md index ae63afbb..392b48cb 100644 --- a/README.md +++ b/README.md @@ -2,7 +2,7 @@ [![build](https://github.com/gaogaotiantian/codesnap/workflows/build/badge.svg)](https://github.com/gaogaotiantian/codesnap/actions?query=workflow%3Abuild) [![pypi](https://img.shields.io/pypi/v/codesnap.svg)](https://pypi.org/project/codesnap/) -CodeSnap is a light-weighted deterministic debugging/profiling tool that can trace and visualize python code. The major data CodeSnap displays is FEE(function entry/exit), or equivalently, the call stack. +CodeSnap is a deterministic debugging/profiling tool that can trace and visualize python code. The major data CodeSnap displays is FEE(function entry/exit), or equivalently, the call stack. Unlike traditional flame graph, which is normally generated by sampling profiler, CodeSnap can display every function executed and the corresponding entry/exit time from the beginning of the program to the end, which is helpful for programmers to catch sporatic performance issues. @@ -12,6 +12,8 @@ You can take a look at the [demo](http://www.minkoder.com/codesnap/result.html) [trace viewer](https://chromium.googlesource.com/catapult) is used to display the stand alone html data. +CodeSnap also supports json output that complies with Chrome trace event format, which can be loaded using [perfetto](https://ui.perfetto.dev/) + ## Requirements CodeSnap requires python 3.5+. No other package is needed. For now, CodeSnap binary on pip only supports CPython + Linux. However, in theory the source code can build on Windows/MacOS. diff --git a/setup.py b/setup.py index 42cc8ff2..ad6240a3 100644 --- a/setup.py +++ b/setup.py @@ -6,10 +6,10 @@ setuptools.setup( name="codesnap", - version="0.0.5", + version="0.1.0", author="Tian Gao", author_email="gaogaotiantian@hotmail.com", - description="A profiling tool that can visualize python code in flame graph", + description="A debugging and profiling tool that can trace and visualize python code", long_description=long_description, long_description_content_type="text/markdown", url="https://github.com/gaogaotiantian/codesnap",