qalam (قلم) — Arabic Code Documentation Generator

Generate Arabic documentation from your code. No API. No translation service. Fully offline.

Why

Arabic developers deserve documentation in their language. qalam scans Python, JavaScript, and TypeScript code and generates Arabic docs using a built-in technical dictionary. No LLM needed. No cloud translation API. Just a deterministic parser and a curated dictionary of 50+ programming terms.

No API keys. No network calls. No data leaves your machine.

Install

pip install qalam

Quick Start

# Generate Arabic docs from your source
qalam generate src/

# Scan code structure (functions, classes, modules)
qalam scan src/

# Translate a single programming term
qalam translate "function"

# Browse the full Arabic tech dictionary
qalam dict

Commands

Command	Description
generate	Generate Arabic documentation from source code. Parses functions, classes, and modules, then produces Arabic Markdown, docstrings, or HTML.
scan	Scan a directory and list all detected functions, classes, and modules. Shows structure without generating docs.
translate	Translate a single programming term to Arabic using the built-in dictionary.
dict	Print the full Arabic tech dictionary. 300+ terms with English-Arabic mappings.
explain	Show how qalam works — parsing pipeline, dictionary lookup, and output formats.

Supported Languages

Language	Extensions
Python	.py
JavaScript	.js, .jsx
TypeScript	.ts, .tsx

Output Formats

Format	Description
Markdown	Arabic .md files with RTL formatting
Docstring	Inject Arabic docstrings directly into source files
README section	Generate an Arabic section for your existing README
HTML (RTL)	Standalone RTL HTML documentation page

Arabic Tech Dictionary

qalam ships with a curated dictionary of 50+ programming terms translated to Arabic:

English	Arabic
function	دالة
variable	متغير
class	صنف
parameter	معامل
return value	قيمة مرجعة
array	مصفوفة
string	سلسلة نصية
loop	حلقة
exception	استثناء
module	وحدة
...	40+ more

Fully Offline

• No API keys required
• No network calls
• No translation service dependency
• No data leaves your machine
• Works in air-gapped environments

---

مقدمة من مجتمع الذكاء الاصطناعي السعودي للعرب أولا وللعالم أجمع

Brought to you by the Saudi AI Community — for Arabs first, and the world at large.

License

MIT — Musa the Carpenter

---

The Series: artok · bidi-guard · arabench · majal · khalas · safha · raqeeb · sarih · qalam