Metadata-Version: 2.1
Name: space-tracer
Version: 4.9.0
Summary: Trade time for space when debugging your code.
Home-page: https://donkirkby.github.io/live-py-plugin/
Author: Don Kirkby
Author-email: donkirkby@gmail.com
Project-URL: Bug Reports, https://github.com/donkirkby/live-py-plugin/issues
Project-URL: Source, https://github.com/donkirkby/live-py-plugin
Classifier: Intended Audience :: Developers
Classifier: Topic :: Software Development :: Debuggers
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Console
Description-Content-Type: text/markdown

Space Tracer
============
Trade Time for Space When You Debug
-----------------------------------
The Space Tracer displays what happens to your code so you can read through it
like a book, instead of stepping through it like most debuggers. For example,
here's a simple script that assigns a variable, then loops a few times making
changes to that variable, before printing out the final message.

    message = 'Hello, World'
    for i in range(3):
        message += '!'
    print(message)
   
A regular debugger would let you set break points, look at variable values, and
step through the code. Space Tracer shows you the code with all of the
variable assignments, and the loop iterations in columns. Here, you see the
script on the left, and the variable values and loops on the right, so you can
read through what happened, like reading a book.

    message = 'Hello, World' | message = 'Hello, World' 
    for i in range(3):       | i = 0                     | i = 1                      | i = 2 
        message += '!'       | message = 'Hello, World!' | message = 'Hello, World!!' | message = 'Hello, World!!!' 
    print(message)           | print('Hello, World!!!') 

You can run Space Tracer as a command-line tool, or you can use it in the
[Live Coding in Python] plugins for PyCharm, Emacs, and Sublime Text. See the
[Getting Started] page for a full introduction.

Installing Space Tracer
-----------------------
Space Tracer is a regular Python package, so you can install it with
`pip install space_tracer`. If you haven't installed Python packages before,
read Brett Cannon's [quick-and-dirty guide].

Then copy the script above into a file called `hello.py`, and run it with the
`space_tracer` command:

    $ space_tracer hello.py
    message = 'Hello, World' | message = 'Hello, World' 
    for i in range(3):       | i = 0                     | i = 1                      | i = 2 
        message += '!'       | message = 'Hello, World!' | message = 'Hello, World!!' | message = 'Hello, World!!!' 
    print(message)           | print('Hello, World!!!') 
    $

[Live Coding in Python]: https://donkirkby.github.io/live-py-plugin/
[Getting Started]: https://donkirkby.github.io/live-py-plugin/starting_space_tracer.html
[quick-and-dirty guide]: https://snarky.ca/a-quick-and-dirty-guide-on-how-to-install-packages-for-python/
