Skip to content

Commit 6b690e2

Browse files
authored
Update README.md
1 parent bffaf32 commit 6b690e2

File tree

1 file changed

+16
-1
lines changed

1 file changed

+16
-1
lines changed

README.md

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,17 @@
11
# Python Interactive Exception Console
2-
Python interactive startup file with GUI exception console and PyQt5 imports. For ease of use with PyQt5 Testing or libraries with verbose exception tracebacks such as Pandas.
2+
Python Interactive GUI console that displays exceptions and tracebacks in an interactive python environment, and provides a sidebar for selecting which exception.
3+
Provides PyQt5 imports For ease of use with PyQt5 Testing or libraries with verbose exception tracebacks.
4+
5+
6+
## Run
7+
The `exception_viewer.py` script contains the neccecary startup code when run as `__main__`, and python must be run in interactive mode.
8+
- Run as Script: `pythonw -i exception_viewer.py` or `python -i exception_viewer.py`
9+
- To run as module: `pythonw -im exception_viewer` or `python -im exception_viewer`
10+
11+
Running as module will be used if this module is installed in python site packages (TODO).
12+
13+
The scripts use `pythonw`, but can be replaced with regular `python` if `pythonw` is not available.
14+
15+
## Note:
16+
This project is experimental, so names and features are likely to change, and there is __no warrantry__. A formal releasse will likely be done under a new repo with a better package name, and this repo will be archived.
17+

0 commit comments

Comments
 (0)