Skip to content
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
143 changes: 143 additions & 0 deletions README.maithili.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,143 @@
# README.md

# 📜 Devnagiri Maithili DSL

एकटा आधुनिक पायथन-संगत प्रोग्रामिंग डीएसएल जे **देवनागरी लिपि** क उपयोग कए **मैथिली** मे कोड लिखबाक सुविधा दैत अछि |

-----

## 🔧 विशेषता
- ✅ पायथन मे मैप कएल गेल पूर्ण मैथिली वाक्य रचना
- ✅ ओओपी (वर्ग, विधि, स्वयं) के समर्थन करैत अछि
- ✅ देवनागरी अंक (`0-9`)
- ✅ अंतर्निहित मॉड्यूल अनुवाद (जैसे, `गणित` → `गणित`)
- ✅ मैथिली मे रनटाइम एरर मैसेज
- ✅ मैथिली मे स्टाइल & सिंटैक्स फीडबैक के साथ लिंटर
- ✅ कमांड-लाइन टूल: `python_maithili` (क्रॉस-प्लेटफॉर्म) के साथ `.dmai` फाइल चलाएँ

----

## 🚀 शुरू भ रहल अछि

### 📦 स्थापना
रेपो के क्लोन करू:

Clone the repo:
```bash
git clone https://github.com/alphacrack/python-maithili-dsl.git
cd python-maithili-dsl
```

### 🔧 Install CLI Tool (cross-platform)
```bash
pip install .
```

आब अहाँ दुनू मे सँ कोनो एंट्री प्वाइंट क उपयोग कए मैथिली लिपि चला सकैत छी :
```bash
python_maithili examples/hello.dmai
# अथवा, कंसोल स्क्रिप्ट इंस्टॉल केने बिना:
python -m maithili_dsl examples/hello.dmai
```

✅ मैक, विंडोज, आ लिनक्स पर काज करैत अछि, पायथन 3.9 – 3.12 पर |

## 📄 उदाहरण के लिये `examples/person.dmai`
```python
वर्ग व्यक्ति:
कार्य नव(स्वयं, नाम):
स्वयं.नाम = नाम

कार्य बोलू(स्वयं):
छपाउ("हमर नाम " + स्वयं.नाम + " अछि।")

व्यक्ति१ = व्यक्ति("सुमन")
व्यक्ति१.बोलू()
```
## 🧠 मैथिली कीवर्ड
| Maithili | Python |
|----------------|--------------|
| `कार्य` | `def` |
| `वर्ग` | `class` |
| `फेर करू` | `return` |
| `स्वयं` | `self` |
| `यदि` | `if` |
| `नहि त` | `else` |
| `प्रत्येक` | `for` |
| `में` | `in` |
| `सत्य` | `True` |
| `मिथ्या` | `False` |
| `शून्य` | `None` |

---

## 📦 अंतर्निहित मॉड्यूल मैपिंग
| Maithili | Python |
|---------------|---------------|
| `गणित` | `math` |
| `समय` | `time` |
| `यादृच्छिक` | `random` |
| `तिथि` | `datetime` |
| `पुन` | `re` |
| `संग्रह` | `collections` |
| `सिस्टम` | `sys` |
| `पथ` | `os.path` |
| `ओएस` | `os` |
| `आँकड़ा` | `statistics` |

----

## 🧹 लिंटिंग एवं त्रुटि
- ❗ चलने से पहले पकड़ा आम गलती
- ❗ मैथिली मे देखाओल गेल रनटाइम त्रुटि:
```bash
⚠️ त्रुटि: कोनो नाम घोषित नहि अछि।
```

---

## 🔐 सुरक्षा
`.dmai` स्क्रिप्ट क॑ सैंडबॉक्स म॑ निष्पादित करलऽ जाय छै: एक प्रतिबंधित `__builtins__`
मैपिंग (कोई `exec` / `eval` / `open` / `compile` / `breakpoint`) और एक
मॉड्यूल import whitelist `MAITHILI_MODULES` सँ मैप कएल गेल. row python

'import` कथन जे मैथिली नाम स अनुवाद नहि भेल छल से अछि रन करे स पहिने खारिज क देल गेल।

कोनों भेद्यता कें रिपोर्ट करय कें लेल, [SECURITY.md](SECURITY.md) देखू |

---


## 🧪 परीक्षण
परीक्षणक संग योगदान आबय के उम्मीद अछि. पूरा सूट चलाउ:
```bash
pip install -r requirements-dev.txt
pytest -v --cov=maithili_dsl --cov-report=term-missing
```
कवरेज गेट: कुल मिलाकर ≥85%, `cli.py`, `transpile.py` पर ≥90%, और
`linter.py`। पूरा लेल [CONTRIBUTING.md](CONTRIBUTING.md) देखू
कार्यप्रवाह।

---

## 🤝 योगदान देते हुए
देखू [`CONTRIBUTING.md`](CONTRIBUTING.md) ई जानय लेल जे अहाँ एहि DSL केँ बनेबा आओर सुधारय मे कोना मदद क' सकैत छी.
नीक प्रवेश बिंदु मुद्दा लेबल अछि
[`अच्छा पहिल अंक`](https://github.com/alphacrack/python-maithili-dsl/labels/good%20first%20issue)।
इ परियोजना [योगदानकर्ता वाचा आचार संहिता](CODE_OF_CONDUCT.md) कें पालन करयत छै.

---

## 📄 लाइसेंस
ई परियोजना **MIT लाइसेंस** के तहत लाइसेंस प्राप्त अछि. विवरणक लेल [LICENSE](LICENSE) फाइल देखू.

---

## 🌐 भविष्य के लक्ष्य
- 🌍 तिरहुता लिपि समर्थन
- 🌐 `.dmai` के लिये वेब REPL |
- 🔌 VS कोड विस्तार
- `जखन`(जबतक) आ `प्रयास/`सिवाय` (प्रयास`/`अवाद`) कीवर्ड
- सीआई मे हिंट आ `mypy` टाइप करू

---
Loading