Skip to content

Commit

Permalink
مراجعة نصوص شرح المكتبة
Browse files Browse the repository at this point in the history
  • Loading branch information
vzool committed Jun 23, 2024
1 parent bc4a11c commit d761e94
Show file tree
Hide file tree
Showing 5 changed files with 74 additions and 59 deletions.
19 changes: 10 additions & 9 deletions README.ar.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,8 @@

<div dir="rtl">

# متتبع الزكاة (ZakatTracker): مكتبة بايثون لإدارة الزكاة الإسلامية
# :star_and_crescent: الزكاة (Zakat): مكتبة بايثون للإدارة المالية الإسلامية
** **يجب علينا إخراج الزكاة إذا بلغت حد الحول والنصاب لكل معاملة** **
###### [تحت التطوير النشط]
</div>

Expand All @@ -18,23 +19,23 @@

<div dir="rtl">

متتبع الزكاة (ZakatTracker) هي مكتبة بايثون سهلة الاستخدام مصممة لتبسيط عملية تتبع وحساب الزكاة، وهي ركن أساسي في المالية الإسلامية. سواء كنت فردًا أو مؤسسة، يوفر متتبع الزكاة (ZakatTracker) الأدوات اللازمة لإدارة التزاماتك الزكوية بدقة.
الزكاة (Zakat) هي مكتبة بايثون سهلة الاستخدام مصممة لتبسيط عملية تتبع وحساب الزكاة، وهي ركن أساسي في المالية الإسلامية. سواء كنت فردًا أو مؤسسة، يوفر الزكاة (Zakat) الأدوات اللازمة لإدارة التزاماتك الزكوية بدقة.

### الميزات الرئيسية:

- تتبع المعاملات: سجل بسهولة كل من الدخل والنفقات مع أوصاف مفصلة، مما يضمن سجلات مالية شاملة.

- حساب الزكاة التلقائي: احسب تلقائيًا الزكاة المستحقة بناءً على النصاب (الحد الأدنى) وسعر السوق الحالي للفضة، مما يبسط الامتثال للمبادئ المالية الإسلامية.
- حساب الزكاة التلقائي: احسب تلقائيًا الزكاة المستحقة بناءً على النصاب (الحد الأدنى) والحول (الدورات الزمنية) وسعر السوق الحالي للفضة، مما يبسط الامتثال للمبادئ المالية الإسلامية.

- النصاب القابل للتخصيص: اضبط قيمة النصاب الخاصة بك بناءً على طريقة الحساب المفضلة لديك أو وضعك المالي الشخصي.
- الحول القابل للتخصيص: اضبط مدة الحول الخاصة بك بناءً على التقويم الذي تفضله لديك أو وضعك المالي الشخصي.

- حسابات متعددة: إدارة الزكاة لأصول أو حسابات مختلفة بشكل منفصل لمزيد من الوضوح المالي.

- الاستيراد/التصدير: استيراد بيانات المعاملات بسلاسة من ملفات CSV وتصدير تقارير الزكاة المحسوبة بتنسيق JSON لمزيد من التحليل أو حفظ السجلات.

- استمرارية البيانات: حفظ بيانات متتبع الزكاة الخاصة بك وتحميلها بأمان للاستخدام المستمر عبر الجلسات.

- تتبع السجل: تمكين سجل مفصل اختياري للإجراءات من أجل الشفافية والمراجعة (يمكن تعطيله للخصوصية).
- تتبع السجل: تمكين سجل مفصل اختياري للإجراءات من أجل الشفافية والمراجعة (يمكن تعطيله اختياري).

### الفوائد:

Expand All @@ -46,23 +47,23 @@

- سهل الاستخدام: يمكنك التنقل بسهولة من خلال واجهة المكتبة ووظائفها سهلة الاستخدام، حتى من دون معرفة تقنية واسعة.

- قابل للتخصيص: يمكنك تخصيص إعدادات المكتبة (على سبيل المثال، قيمة النصاب) وفقًا لاحتياجاتك وتفضيلاتك المحددة.
- قابل للتخصيص: يمكنك تخصيص إعدادات المكتبة (على سبيل المثال، قيمة النصاب ومدة الحول) وفقًا لاحتياجاتك وتفضيلاتك المحددة.

### من يمكنه الاستفادة:

- الأفراد: إدارة الشؤون المالية الشخصية بشكل فعال والوفاء بالتزامات الزكاة.

- المنظمات: تبسيط حساب الزكاة وتوزيعها على المشاريع والمبادرات الخيرية.

- المؤسسات المالية الإسلامية: دمج ZakatTracker في الأنظمة الحالية لتحسين الإدارة المالية وإعداد التقارير.
- المؤسسات المالية الإسلامية: دمج الزكاة (Zakat) في الأنظمة الحالية لتحسين الإدارة المالية وإعداد التقارير.

### ابدأ الآن:

قم بتثبيت مكتبة متتبع الزكاة (ZakatTracker) باستخدام pip:
قم بتثبيت مكتبة الزكاة (Zakat) باستخدام pip:

```bash
pip install zakat
```

استكشف الوثائق والأمثلة لبدء تتبع الزكاة الخاصة بك وتحقيق راحة البال المالية وفقًا للمبادئ الإسلامية.
استكشف الوثائق والبرمجة المصدرية والأمثلة لبدء تتبع الزكاة (Zakat) الخاصة بك وتحقيق راحة البال المالية وفقًا للمبادئ الإسلامية.
</div>
17 changes: 10 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,24 +4,27 @@

<div align="center" style="text-align: center;">

# ZakatTracker: A Python Library for Islamic Financial Management
# :star_and_crescent: Zakat: A Python Library for Islamic Financial Management
** **We must pay Zakat if it has reached the Haul and Nisab limits for every transaction** **
###### [UNDER ACTIVE DEVELOPMENT]
<p>
<a href="https://github.com/vzool/zakat/blob/main/README.ar.md"><img src="https://img.shields.io/badge/lang-ar-green.svg" alt="ar" data-canonical-src="https://img.shields.io/badge/lang-en-green.svg" style="max-width: 100%;"></a>
</p>

</div>

ZakatTracker is a user-friendly Python library designed to simplify the tracking and calculation of Zakat, a fundamental pillar of Islamic finance. Whether you're an individual or an organization, ZakatTracker provides the tools to accurately manage your Zakat obligations.
Zakat is a user-friendly Python library designed to simplify the tracking and calculation of Zakat, a fundamental pillar of Islamic finance. Whether you're an individual or an organization, Zakat provides the tools to accurately manage your Zakat obligations.

### Key Features:

- Transaction Tracking: Easily record both income and expenses with detailed descriptions, ensuring comprehensive financial records.

- Automated Zakat Calculation: Automatically calculate Zakat due based on the Nisab (minimum threshold) and the current market price of silver, simplifying compliance with Islamic financial principles.
- Automated Zakat Calculation: Automatically calculate Zakat due based on the Nisab (minimum threshold), Haul (time cycles) and the current market price of silver, simplifying compliance with Islamic financial principles.

- Customizable Nisab: Set your own Nisab value based on your preferred calculation method or personal financial situation.

- Customizable Haul: Set your own Haul cycle based on your preferred calender method or personal financial situation.

- Multiple Accounts: Manage Zakat for different assets or accounts separately for greater financial clarity.

- Import/Export: Seamlessly import transaction data from CSV files and export calculated Zakat reports in JSON format for further analysis or record-keeping.
Expand All @@ -42,22 +45,22 @@ ZakatTracker is a user-friendly Python library designed to simplify the tracking

### Customizable:

- Tailor the library's settings (e.g., Nisab value) to your specific needs and preferences.
- Tailor the library's settings (e.g., Nisab value and Haul cycles) to your specific needs and preferences.

### Who Can Benefit:

- Individuals: Effectively manage personal finances and fulfill Zakat obligations.

- Organizations: Streamline Zakat calculation and distribution for charitable projects and initiatives.

- Islamic Financial Institutions: Integrate ZakatTracker into existing systems for enhanced financial management and reporting.
- Islamic Financial Institutions: Integrate Zakat into existing systems for enhanced financial management and reporting.

### Get Started:

Install the ZakatTracker library using pip:
Install the Zakat library using pip:

```bash
pip install zakat
```

Explore the documentation and examples to begin tracking your Zakat and achieving financial peace of mind in accordance with Islamic principles.
Explore the documentation, source code and examples to begin tracking your Zakat and achieving financial peace of mind in accordance with Islamic principles.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
[project]
name = "zakat"
version = "0.2.0"
version = "0.2.01"
authors = [
{ name="Abdelaziz Elrashed Elshaikh Mohamed", email="[email protected]" },
]
Expand Down
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
setup(
name='zakat',
packages=find_packages(include=['zakat']),
version='0.2.0',
version='0.2.01',
description='A Python Library for Islamic Financial Management.',
author='Abdelaziz Elrashed Elshaikh Mohamed',
install_requires=[],
Expand Down
Loading

0 comments on commit d761e94

Please sign in to comment.