Skip to main content

Interactive Interpreter for Argh!

Project description

Arghonaut

Arghonaut is an interactive interpreter, visualizer, and debugger for Argh! and Aargh!, which are Befunge-like esoteric programming languages designed by Sascha Wilde. Arghonaut is written in Python and includes an ncurses interface.

Arghonaut was created by Aaron Friesen for FOSS Jam 2021, a hackathon hosted by the UNL Operating Systems and Open Source Group.

Installation

pip install arghonaut

To use the UI, make sure you have ncurses or a suitable equivalent installed.

Usage

To run Arghonaut interactively, execute the following command, where src.agh is an Argh! or Aargh! source code file:

arghonaut src.agh

For more detailed usage information, run:

arghonaut --help

Keybindings

Arghonaut supports the following keybindings:

  • . or Enter: step through execution
  • Space: automatically step through execution (0.1 second delay) or pause
  • c: continue until next input
  • hjkl: move the editing cursor
  • b: return the cursor to the instruction pointer
  • g: jump the instruction pointer to the cursor
  • i: enter insert mode (the next character you type will be written into the code at the cursor position)
  • o: open a new line
  • r: reset state (excluding unsaved code changes)
  • n: reset program (including unsaved code changes)
  • s: save current code changes to program state (does not modify source file)
  • q or Escape: quit

Batch Mode

Arghonaut can be run in batch mode by adding the --batch flag. In this mode, the curses interface will not be displayed, and input and output will be performed via standard input and standard output. Programs can be run interactively with standard input from the keyboard, or with redirected or piped input.

Examples

This repository includes some example Argh! and Aargh! programs written by Aaron Friesen. For more examples, refer to the Argh! Mercurial repository.

Contributing

To run Arghonaut from source:

python -m arghonaut src.agh

If you want to submit a patch, please follow these guidelines:

  • Run the project on some of the examples to test for bugs.
  • Run some Python linters to check for and fix any coding style issues.

License

Arghonaut is licensed under the GNU General Public License Version 3. Argh! is licensed under the GNU General Public License Version 2, and permits the use of later versions of the license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

arghonaut-1.5.0.tar.gz (23.5 kB view details)

Uploaded Source

Built Distribution

arghonaut-1.5.0-py2.py3-none-any.whl (23.0 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file arghonaut-1.5.0.tar.gz.

File metadata

  • Download URL: arghonaut-1.5.0.tar.gz
  • Upload date:
  • Size: 23.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for arghonaut-1.5.0.tar.gz
Algorithm Hash digest
SHA256 19807764c5e350aa78aad79a1af939d71f3cff3b3f60d0cdc6e332a9d56dcc0c
MD5 7c6db87736aebc7f02750b49203062ab
BLAKE2b-256 373f885647540b785ad317d60111fc9278a270898ece7c14536f61f830bbd005

See more details on using hashes here.

File details

Details for the file arghonaut-1.5.0-py2.py3-none-any.whl.

File metadata

  • Download URL: arghonaut-1.5.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 23.0 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: python-requests/2.28.1

File hashes

Hashes for arghonaut-1.5.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 1fc4bfff8dbe022e2e33d41d5c3d24355e8db26f5d40b99f7afbe596be7b1131
MD5 76e5cc962d993b76c9d1064fa8577573
BLAKE2b-256 ba6254e876ea0bc17c23b72046c566af4961a3e180fbf9b4b0c72867198f73d7

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page