qalamقلم
Generate Arabic documentation from your code. No API. No translation service. Fully offline.
300+ terms · 4 formats · 3 languages — Arabic-first code documentation for Python, JavaScript, and TypeScript.
$
pip install qalam
Chapter I
The Problem
Arabic devs deserve Arabic docs.
Documentation in English is a barrier for Arabic-speaking developers. Translation APIs leak your code to third parties. LLMs hallucinate technical terms. qalam solves this with a deterministic parser and a curated Arabic technical dictionary. Your code stays on your machine. Your docs come out in Arabic.
Chapter II
Features
Parse. Translate. Generate.
- Arabic Dictionary
300+ programming terms curated by Arabic developers. Not machine-translated. function = دالة, class = صنف, variable = متغير. - Code Parsing
Parses Python, JavaScript, and TypeScript. Extracts functions, classes, parameters, return types, and module structure. - Doc Generation
Generates complete Arabic documentation from parsed code. Function signatures, parameter descriptions, return values — all in Arabic. - 4 Output Formats
Markdown, docstring injection, README sections, or standalone RTL HTML. Pick the format that fits your workflow.
Chapter III
Example
Python in. Arabic docs out.
Your Python Code
def calculate_total(items, tax_rate=0.15): """Calculate total price with tax.""" subtotal = sum(item.price for item in items) return subtotal * (1 + tax_rate)
Arabic Documentation
## دالة: calculate_total حساب السعر الإجمالي مع الضريبة المعاملات: - items: قائمة العناصر - tax_rate: نسبة الضريبة القيمة المرجعة: المجموع الكلي بعد الضريبة
Chapter IV
Supported Languages
3 languages. 6 file types.
| Language | Extensions |
|---|---|
| Python | .py |
| JavaScript | .js .jsx |
| TypeScript | .ts .tsx |
Chapter V
Output Formats
4 formats. Your choice.
| Format | Description |
|---|---|
| Markdown | Arabic .md files with RTL formatting. Ready for GitHub or docs sites. |
| Docstring | Inject Arabic docstrings directly into your source files. |
| README | Generate an Arabic section to append to your existing README. |
| HTML (RTL) | Standalone RTL HTML documentation page. Self-contained. |
Chapter VI
Arabic Tech Dictionary
300+ terms curated by Arabic developers.
| English | Arabic | Category |
|---|---|---|
| function | دالة | Core |
| variable | متغير | Core |
| class | صنف | OOP |
| parameter | معامل | Core |
| return value | قيمة مرجعة | Core |
| array | مصفوفة | Data |
| string | سلسلة نصية | Data |
| loop | حلقة | Control |
| exception | استثناء | Error |
| module | وحدة | Structure |
| import | استيراد | Structure |
| conditional | شرط | Control |
| object | كائن | OOP |
| method | تابع | OOP |
| inheritance | وراثة | OOP |
Demo
See It
Chapter VII
Commands
5 commands. Zero config.
- generate
Generate Arabic docs from source code - scan
List detected functions, classes, modules - translate
Translate a single programming term - dict
Print the full Arabic tech dictionary - explain
Show how qalam works
Chapter VIII
Get Started
# Install
$ pip install qalam
# Generate Arabic docs
$ qalam generate src/
# Scan code structure
$ qalam scan src/
# Translate a term
$ qalam translate "function"
# Browse the dictionary
$ qalam dict
# Learn how it works
$ qalam explain