Tiny8 documentation

Tiny8 is a lightweight toolkit that allows you to explore how computers work at their core through small-scale memory models, handcrafted assembly, and lightweight in-memory data structures. Designed for rapid experimentation, Tiny8 embraces minimalism with zero unnecessary dependencies, a clean design, and intuitive visualization tools that make learning, debugging, and tinkering enjoyable.

Installation

Tiny8 supports Python 3.11 and newer. It has no heavy external dependencies and is suitable for inclusion in virtual environments. Follow the steps below to prepare your environment and install from source or PyPI.

Prerequisites

• Python 3.11+

• Git (for installing from the repository)

• Recommended: create and use a virtual environment

From source (development)

git clone https://github.com/sql-hkr/tiny8.git
cd tiny8
uv venv
source .venv/bin/activate
uv sync

Tip

uv is an extremely fast Python package and project manager, written in Rust. To install it, run:

# On macOS and Linux.
curl -LsSf https://astral.sh/uv/install.sh | sh

# On Windows.
powershell -ExecutionPolicy ByPass -c "irm https://astral.sh/uv/install.ps1 | iex"

This flow sets up a development virtual environment, installs development requirements, and prepares the project for local editing and testing.

From PyPI (stable)

uv add tiny8

Examples

• Examples
  • Fibonacci
  • Bubble sort

API Reference

The API section documents the public modules, classes, functions, and configuration options. It includes usage notes, parameter descriptions, and return value details so you can use the library reliably in production code.

• tiny8 package
  • tiny8.assembler module
  • tiny8.cpu module
  • tiny8.memory module
  • tiny8.parser module
  • tiny8.visualizer module

License

Tiny8 is licensed under the MIT License. See LICENSE for details. Contributions, bug reports, and pull requests are welcome; please follow the repository’s CONTRIBUTING guidelines.