riscv-emulator 0.1.1

A Python-based RISC-V assembler, emulator, disassembler, and debugger

🖥️ RISC-V Emulator

A simple RISC-V assembler, emulator, and disassembler written in Python.
It can be used both as a command-line tool and as a Python library.

---

👋 Features

• Assemble .s RISC-V assembly files into binary machine code
• Run binary files on a simple RISC-V CPU emulator
• Disassemble binary files back into readable assembly
• One-step assemble-and-run mode
• Works as both CLI tool and importable Python package

---

📦 Installation

From PyPI:

pip install riscv-emulator

From source:

git clone https://github.com/samalneedi/riscv_emulator.git
cd riscv_emulator
pip install .

---

🚀 Usage

CLI Commands

# Assemble a file
riscv assemble program.s

# Run a binary
riscv run program.bin

# Assemble and run in one step
riscv full program.s

# Disassemble a hexcode
riscv disassemble [hexcode]

---

Python API

from riscv_emulator import emulator

emu = emulator()
emu.assemble("program.s")
emu.load_program("program.bin")
emu.run()

---

📂 Project Structure

riscv_emulator/
├── riscv_emulator/
│   ├── __init__.py
│   ├── assembler.py
│   ├── debugger.py
│   ├── disassembler.py
│   ├── emulator.py
│   ├── main.py
├── README.md
├── pyproject.toml
├── LICENSE

---

📝 License

This project is licensed under the terms of the MIT License.
See the LICENSE file for details.

---

💡 Example

Example assembly file (program.s):

addi x1, zero, 3
addi x2, zero, 4
add  x3, x1, x2

Run it:

riscv full program.s

---

🤝 Contributing

Pull requests are welcome!
If you find a bug or have a feature request, please open an issue on GitHub.

---

🛠 Requirements

• Python 3.8+
• No external dependencies