qurankit-core 0.1.0__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (38) hide show
  1. qurankit/__init__.py +86 -0
  2. qurankit/analysis/__init__.py +28 -0
  3. qurankit/analysis/mutashabihat.py +692 -0
  4. qurankit/analysis/reports.py +252 -0
  5. qurankit/cli/__init__.py +5 -0
  6. qurankit/cli/main.py +468 -0
  7. qurankit/core/__init__.py +6 -0
  8. qurankit/core/config.py +64 -0
  9. qurankit/core/exceptions.py +74 -0
  10. qurankit/core/quran.py +643 -0
  11. qurankit/datasets/__init__.py +29 -0
  12. qurankit/datasets/import_pipeline.py +254 -0
  13. qurankit/datasets/manifest.py +125 -0
  14. qurankit/datasets/registry.py +126 -0
  15. qurankit/datasets/validation.py +398 -0
  16. qurankit/mcp/__init__.py +11 -0
  17. qurankit/mcp/server.py +325 -0
  18. qurankit/models/__init__.py +90 -0
  19. qurankit/models/annotations.py +127 -0
  20. qurankit/models/enums.py +84 -0
  21. qurankit/models/lexicon.py +95 -0
  22. qurankit/models/provenance.py +93 -0
  23. qurankit/models/research.py +93 -0
  24. qurankit/models/text.py +155 -0
  25. qurankit/providers/__init__.py +11 -0
  26. qurankit/providers/qac/__init__.py +11 -0
  27. qurankit/providers/qac/provider.py +325 -0
  28. qurankit/providers/tanzil.py +430 -0
  29. qurankit/search/__init__.py +21 -0
  30. qurankit/search/engine.py +358 -0
  31. qurankit/search/normalization.py +385 -0
  32. qurankit/storage/__init__.py +507 -0
  33. qurankit/storage/access.py +967 -0
  34. qurankit_core-0.1.0.dist-info/METADATA +108 -0
  35. qurankit_core-0.1.0.dist-info/RECORD +38 -0
  36. qurankit_core-0.1.0.dist-info/WHEEL +4 -0
  37. qurankit_core-0.1.0.dist-info/entry_points.txt +3 -0
  38. qurankit_core-0.1.0.dist-info/licenses/LICENSE +21 -0
qurankit/__init__.py ADDED
@@ -0,0 +1,86 @@
1
+ """
2
+ QuranKit — A modular, Python-first computational Qur'anic research library.
3
+
4
+ This package provides tools for accessing and analyzing Qur'anic text
5
+ with proper provenance, licensing, and textual integrity.
6
+ """
7
+
8
+ from qurankit.core import Quran, QuranKitConfig
9
+ from qurankit.core.exceptions import (
10
+ DatasetNotFoundError,
11
+ InvalidReferenceError,
12
+ MissingAnnotationError,
13
+ QuranKitError,
14
+ UnsupportedEditionError,
15
+ )
16
+ from qurankit.models import (
17
+ Annotation,
18
+ Ayah,
19
+ AyahMetadata,
20
+ AyahText,
21
+ ComparisonResult,
22
+ Dataset,
23
+ DatasetManifest,
24
+ GrammarAnalysis,
25
+ Lemma,
26
+ LexicalEntry,
27
+ LexicalResource,
28
+ NormalizationProfile,
29
+ ResearchInput,
30
+ ResearchResult,
31
+ ResearchRun,
32
+ Root,
33
+ SemanticRelation,
34
+ Source,
35
+ Surah,
36
+ TextEdition,
37
+ TokenAnalysis,
38
+ WordToken,
39
+ )
40
+ from qurankit.search import SearchEngine, SearchResult, SearchResultType
41
+ from qurankit.storage import DataAccess, Database, get_database
42
+
43
+ __version__ = "0.1.0"
44
+
45
+ __all__ = [
46
+ # Core
47
+ "Quran",
48
+ "QuranKitConfig",
49
+ # Exceptions
50
+ "QuranKitError",
51
+ "DatasetNotFoundError",
52
+ "InvalidReferenceError",
53
+ "UnsupportedEditionError",
54
+ "MissingAnnotationError",
55
+ # Models
56
+ "Source",
57
+ "Dataset",
58
+ "DatasetManifest",
59
+ "Surah",
60
+ "Ayah",
61
+ "TextEdition",
62
+ "AyahText",
63
+ "WordToken",
64
+ "NormalizationProfile",
65
+ "LexicalResource",
66
+ "LexicalEntry",
67
+ "Root",
68
+ "Lemma",
69
+ "TokenAnalysis",
70
+ "GrammarAnalysis",
71
+ "SemanticRelation",
72
+ "AyahMetadata",
73
+ "Annotation",
74
+ "ResearchRun",
75
+ "ResearchInput",
76
+ "ResearchResult",
77
+ "ComparisonResult",
78
+ # Search
79
+ "SearchEngine",
80
+ "SearchResult",
81
+ "SearchResultType",
82
+ # Storage
83
+ "Database",
84
+ "DataAccess",
85
+ "get_database",
86
+ ]
qurankit/analysis/__init__.py ADDED
@@ -0,0 +1,28 @@
1
+ """Analysis module for QuranKit.
2
+
3
+ Provides mutashabihat engine and comparison reports.
4
+ """
5
+
6
+ from __future__ import annotations
7
+
8
+ from qurankit.analysis.mutashabihat import (
9
+ MutashabihatEngine,
10
+ MutashabihatResult,
11
+ PhraseMatch,
12
+ MatchMethod,
13
+ MatchCategory,
14
+ )
15
+ from qurankit.analysis.reports import (
16
+ ComparisonReport,
17
+ ReportGenerator,
18
+ )
19
+
20
+ __all__ = [
21
+ "MutashabihatEngine",
22
+ "MutashabihatResult",
23
+ "PhraseMatch",
24
+ "MatchMethod",
25
+ "MatchCategory",
26
+ "ComparisonReport",
27
+ "ReportGenerator",
28
+ ]