whitespace 1.0.0b2

A Whitespace interpreter.

An interpreter written in Python for the imperative, stack based language called Whitespace.

Installation

Install it using:

$ pip install whitespace

You would now have access to an executable called whitespace. Type

$ whitespace -h

to learn more.

Usage

Let’s say you’ve written a Whitespace program and stored it in the file program.ws. Then, to execute that program, type:

$ whitespace program.ws

You can find example Whitespace programs at tests/fixtures. Be sure to run them to see what they do.

For example, here’s the factorial program and a sample execution:

$ whitespace fact.ws
Enter a number: 40
40! = 20397882081197443358640281739902897356800000000

Development

Get the source code.

$ git clone [e-mail]:dwayne/whitespace-python.git

Create a virtual environment and activate it.

$ cd whitespace-python
$ pyvenv venv
$ . venv/bin/activate

Then, upgrade pip and setuptools and install the development dependencies.

(venv) $ pip install -U pip setuptools
(venv) $ pip install -r requirements-dev.txt

You’re now all set to begin development.

Testing

Tests are written using the unittest unit testing framework.

Run all tests.

(venv) $ python -m unittest

Run a specific test module.

(venv) $ python -m unittest tests.test_parser

Run a specific test case.

(venv) $ python -m unittest tests.test_parser.ParserTestCase

Run a specific test method.

(venv) $ python -m unittest tests.test_parser.ParserTestCase.test_it_parses_push

References

• Whitespace tutorial

Credits

Thanks to Edwin Brady and Chris Morris for designing/developing this programming language (also developers of the Idris programming language). I’ve had lots of fun playing with it and writing interpreters (in Racket, Haskell, Ruby and now Python) for it.

Copyright

Copyright (c) 2016 Dwayne Crooks. See LICENSE for further details.

Change Log

1.0.0b2 (2016-09-03)

Added

• A change log (guided by http://keepachangelog.com/)

• Notes on installation, usage, development and testing to the README

• A version badge from http://shields.io/

• Begin tracking development dependencies

Changed

• Explicitly list the packages to be included in the distribution

• Stop including tests in the distribution

• Stop using codecs.open since open does the job in Python 3

• Consistently name test cases with a TestCase suffix

1.0.0b1 (2016-09-02)

Added

• A fully tested parser with error handling and source location tracking

• An interpreter

• A CLI for running the interpreter

Fixed

• Fix the console’s output buffering by flushing after every write

0.1.0.dev2 (2016-09-01)

Changed

• Update MANIFEST.in and setup.py to ensure the correct files are included in the distribution

0.1.0.dev1 (2016-08-31)

Added

• A virtual machine

• A console abstraction to make it easier to test I/O

• The stack manipulation, arithmetic, heap access, flow control and I/O instructions

0.0.1.dev1 (2016-08-31)

Birth!