Merge pull request #1 from Techno-Disaster/master

PyPi Release

README.md

@@ -1,8 +1,18 @@
 # TDebugger
 A advanced python debugger with live tracing
+## Installation
+Use the `pip` package manager to install TDebugger
+```shell script
+pip install TDebugger
+```
+Then, you can run it as a command-line tool:
+```shell script
+TDebugger.py --help
+```
+
 ## Output:
 ![video](assets/tdebugger.gif)
-![output](https://github.com/Techno-Disaster/TDebugger/blob/master/images/py5.png)
+![output](https://github.com/Techno-Disaster/TDebugger/blob/master/assets/py6binarysearch.png)
 
 
 

TDebugger.egg-info/PKG-INFO

@@ -0,0 +1,32 @@
+Metadata-Version: 2.1
+Name: TDebugger
+Version: 0.1.0
+Summary: A advanced python debugger with live tracing that outputs video logs of a program's execution.
+Home-page: https://github.com/CCExtractor/TDebugger
+Author: Jayesh Nirve
+Author-email: [email protected]
+License: UNKNOWN
+Description: # TDebugger
+        A advanced python debugger with live tracing
+        ## Installation
+        Use the `pip` package manager to install TDebugger
+        ```shell script
+        pip install TDebugger
+        ```
+        Then, you can run it as a command-line tool:
+        ```shell script
+        TDebugger.py --help
+        ```
+
+        ## Output:
+        ![video](assets/tdebugger.gif)
+        ![output](https://github.com/Techno-Disaster/TDebugger/blob/master/assets/py6binarysearch.png)
+
+
+
+        Moving to CCextracter.
+
+Platform: UNKNOWN
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.7
+Description-Content-Type: text/markdown

TDebugger.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+README.md
+setup.py
+TDebugger/TDebugger.py
+TDebugger.egg-info/PKG-INFO
+TDebugger.egg-info/SOURCES.txt
+TDebugger.egg-info/dependency_links.txt
+TDebugger.egg-info/entry_points.txt
+TDebugger.egg-info/requires.txt
+TDebugger.egg-info/top_level.txt
+TDebugger/TestAlgos/sorting.py
+TDebugger/TestAlgos/test.py

TDebugger.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

TDebugger.egg-info/entry_points.txt

@@ -0,0 +1,3 @@
+[console_scripts]
+TDebugger = TDebugger.TDebugger:main
+

TDebugger.egg-info/requires.txt

@@ -0,0 +1,4 @@
+Pillow
+opencv-python
+numpy
+pyyaml

TDebugger.egg-info/top_level.txt

@@ -0,0 +1 @@
+TDebugger

TDebugger.py → TDebugger/TDebugger.py

@@ -339,15 +339,20 @@ def funcarg(argument):
 
 debugGroup = parser.add_argument_group(
     title="Analysis")
-debugGroup.add_argument("--debug", "-d", metavar="FILE")
-debugGroup.add_argument("--function", "-f", nargs='*',
-                        )
+debugGroup.add_argument("--debug", "-d",  help=".\n".join(
+    ["Path of a *.py file to debug", "Example: '--debug/-d main.py' will run the file main.py."]), metavar="FILE")
+debugGroup.add_argument("--function", "-f", help=".\n".join(
+    ["If --debug FILE is present, optionally provide the name of a function to debug and function arguments", "(defaults to main with no arguments)",
+     "Example: '--func/-f foo 10' will run foo(10)."]), nargs='+', default=["main"], metavar=("FUNC", "PARAMETER"))
 
-debugGroup.add_argument("--output", "-o", metavar="FILE")
+
+debugGroup.add_argument("--output", "-o", help="./n".join(
+    ["will output the logs in result.json file \nIMPORTANT name output file 'result.json' if you want to create a video later, \nExample: ' TDebugger -d foo.py -f test2 10 -o result.json'"]), metavar="FILE")
 
 printGroup = parser.add_argument_group(
     title="Reporting")
-printGroup.add_argument("--parse", "-p", metavar="FILE")
+printGroup.add_argument("--parse", "-p", help="./n".join(
+    ["parses a .json file(eg. the result.json file created with --output/-o argument) file in readable format."]), metavar="FILE")
 videoGroup = parser.add_argument_group(
     title="Video Reporting", description="Generating a video displaying the program's flow and execution.")
 videoGroup.add_argument("--video", "-v",
@@ -371,7 +376,7 @@ def funcarg(argument):
         terminal = Terminal(results)
         terminal.terminal()
     with open(
-            "/home/Techno-Disaster/PycharmProjects/TechnoDebugger/result.json", "wb") as f:
+            "./result.json", "wb") as f:
         pickle.dump(results, f)
 
 elif args.parse:
@@ -385,4 +390,4 @@ def funcarg(argument):
     reporter = VideoOutput(args.video[0], args.video[1], parsed_data)
     reporter.generate_video(args.video[3])
 else:
-    print("Run <<\"python3 TDebugger.py --help\">>")
+    print("Run <<\"TDebugger --help\">>")