Open
Conversation
Add modern packaging metadata so the repo can be installed locally with pip install -e . while preserving legacy import paths. - add pyproject.toml with setuptools backend and project metadata - add MANIFEST.in and package corpus XML data - introduce pyquran/ package namespace with wrapper modules for core and tools - add top-level shim modules (quran, arabic, searchHelper, filtering, error, buckwalter, shapeHelper) to keep old absolute imports working - add QuranCorpus/__init__.py so corpus data is package-addressable - make package __init__ resilient when optional runtime deps (numpy, pyarabic) are not yet installed - document editable local install steps in README.md This is a compatibility-first packaging step, internal import cleanup will follow in a separate refactor commit insha'Allah
Modernize import structure after editable-install bootstrap by removing
legacy top-level shim modules and converting internal code to use
pyquran.tools... imports directly.
- remove root shim modules:
- arabic.py, quran.py, searchHelper.py, filtering.py,
error.py, buckwalter.py, shapeHelper.py
- migrate runtime imports in core/tools to package-qualified paths
- remove path-mutation bootstrap code from core/__init__.py and
tools/__init__.py
- update tests to import from pyquran / pyquran.tools instead of
manipulating sys.path
- update testing/run_test.sh to set PYTHONPATH to project root
- update documentation/auto_gen_docs.py imports to package paths
- update packaging metadata in pyproject.toml to stop exporting removed
shim modules
- fix NumPy compatibility by replacing deprecated numpy.int with
builtin int in core/pyquran.py
Still need wo figure out why some tests are broken
…zation
- update testing/test_shape_systems.py to call pyquran.count_rasm
- update docs/examples to use count_rasm
- improve recitation symbol filtering in tools/filtering.py:
- remove additional Quran annotation marks (including U+06D7 and range
U+06D6..U+06ED)
- normalize hamza_above (U+0654) to standalone hamza (U+0621)
- normalize whitespace after symbol removal
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR aims to bring the package up to date, as well as improve support and modernise the repo
Main changes:
More details in the commit descriptions