Skip to content

Commit

Permalink
Ready for 0.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
gaogaotiantian committed Aug 11, 2020
1 parent fc263ce commit a0b3a02
Show file tree
Hide file tree
Showing 2 changed files with 5 additions and 3 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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.

Expand All @@ -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.
Expand Down
4 changes: 2 additions & 2 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,10 @@

setuptools.setup(
name="codesnap",
version="0.0.5",
version="0.1.0",
author="Tian Gao",
author_email="[email protected]",
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",
Expand Down

0 comments on commit a0b3a02

Please sign in to comment.