In Action
Translate. Parse. Document.
Generate Arabic documentation from your code. No API. No translation service. Fully offline.
pip install qalam
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.
300+ programming terms curated by Arabic developers. Not machine-translated. function = دالة, class = صنف, variable = متغير.
Parses Python, JavaScript, and TypeScript. Extracts functions, classes, parameters, return types, and module structure.
Generates complete Arabic documentation from parsed code. Function signatures, parameter descriptions, return values — all in Arabic.
Markdown, docstring injection, README sections, or standalone RTL HTML. Pick the format that fits your workflow.
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)
## دالة: calculate_total حساب السعر الإجمالي مع الضريبة المعاملات: - items: قائمة العناصر - tax_rate: نسبة الضريبة (افتراضي: 0.15) القيمة المرجعة: المجموع الكلي بعد الضريبة
Generate Arabic documentation from source code. Parses functions, classes, and modules. Outputs Markdown, docstrings, or HTML.
Scan a directory and list detected functions, classes, and modules. Preview your code structure before generating docs.
Translate a single programming term to Arabic. Quick lookup from the built-in technical dictionary.
Print the full Arabic tech dictionary. 300+ terms with English-Arabic mappings for reference.
Show how qalam works — parsing pipeline, dictionary lookup, and output format details.
Arabic .md files with RTL formatting. Ready for GitHub or docs sites.
Inject Arabic docstrings directly into your source files.
Generate an Arabic section to append to your existing README.
Standalone RTL HTML documentation page. Self-contained and ready to serve.
| 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 |
