ஒரு மேம்பாட்டுச் சூழலை அமைத்தல்¶
BeeWare Docs Tools-க்கு பங்களிப்பதற்கு, நீங்கள் ஒரு மேம்பாட்டுச் சூழலை அமைக்க வேண்டும்.
முன்நிபந்தனைகள்¶
பின்வரும் முன்நிபந்தனைகளை நீங்கள் நிறுவ வேண்டும்.
BeeWare Docs Tools க்கு Python 3.10+ தேவை. மெய்நிகர் சூழல்களை நிர்வகிப்பதற்கான ஒரு முறையையும் (எ.கா. venv) நீங்கள் பயன்படுத்த வேண்டும்.
பின்வருவதை இயக்கி, நீங்கள் நிறுவியுள்ள பைத்தானின் பதிப்பைச் சரிபார்க்கலாம்:
பைத்தான் 3.8.10
நீங்கள் பைத்தனின் ஒன்றுக்கு மேற்பட்ட பதிப்புகளை நிறுவியிருந்தால், நீங்கள் python3 என்பதை ஒரு குறிப்பிட்ட பதிப்பு எண்ணுடன் (எ.கா., python3.13) மாற்ற வேண்டியிருக்கலாம்.
சமீபத்தில் வெளியிடப்பட்ட பைத்தானின் பதிப்பைத் (அதாவது, ".0" அல்லது ".1" என்ற நுண் பதிப்பு எண்ணைக் கொண்ட பதிப்புகள், எ.கா., 3.14.0) தவிர்க்கப் பரிந்துரைக்கிறோம். ஏனெனில், macOS-இல் பைத்தானை ஆதரிக்கத் தேவையான கருவிகள், சமீபத்தில் வெளியிடப்பட்ட நிலையான பைத்தான் பதிப்புகளுக்குப் பொதுவாகக் கிடைப்பதில்லை அல்லது தாமதமாகக் கிடைக்கின்றன.
BeeWare Docs Tools க்கு Python 3.10+ தேவை. மெய்நிகர் சூழல்களை நிர்வகிப்பதற்கான ஒரு முறையையும் (எ.கா. venv) நீங்கள் பயன்படுத்த வேண்டும்.
பின்வருவதை இயக்கி, நீங்கள் நிறுவியுள்ள பைத்தானின் பதிப்பைச் சரிபார்க்கலாம்:
பைத்தான் 3.8.10
நீங்கள் பைத்தனின் ஒன்றுக்கு மேற்பட்ட பதிப்புகளை நிறுவியிருந்தால், நீங்கள் python3 என்பதை ஒரு குறிப்பிட்ட பதிப்பு எண்ணுடன் (எ.கா., python3.13) மாற்ற வேண்டியிருக்கலாம்.
சமீபத்தில் வெளியிடப்பட்ட பைத்தானின் பதிப்பைத் (அதாவது, ".0" அல்லது ".1" என்ற நுண் பதிப்பு எண்ணைக் கொண்ட பதிப்புகள், எ.கா., 3.14.0) தவிர்க்குமாறு நாங்கள் பரிந்துரைக்கிறோம். ஏனெனில், லினக்ஸில் பைத்தானை ஆதரிக்கத் தேவையான கருவிகள், சமீபத்தில் வெளியிடப்பட்ட நிலையான பைத்தான் பதிப்புகளுக்குப் பொதுவாகக் கிடைப்பதில்லை.
BeeWare Docs Tools க்கு Python 3.10+ தேவை. மெய்நிகர் சூழல்களை நிர்வகிப்பதற்கான ஒரு முறையையும் (எ.கா. venv) நீங்கள் பயன்படுத்த வேண்டும்.
பின்வருவதை இயக்கி, நீங்கள் நிறுவியுள்ள பைத்தானின் பதிப்பைச் சரிபார்க்கலாம்:
C:\...>py -3 --version
உங்களிடம் பைத்தனின் ஒன்றுக்கு மேற்பட்ட பதிப்புகள் நிறுவப்பட்டிருந்தால், நீங்கள் -3-ஐ ஒரு குறிப்பிட்ட பதிப்பு எண்ணுடன் (எ.கா., -python3.13) மாற்ற வேண்டியிருக்கலாம்.
சமீபத்தில் வெளியிடப்பட்ட பைத்தானின் பதிப்பைத் (அதாவது, ".0" அல்லது ".1" என்ற நுண் பதிப்பு எண்ணைக் கொண்ட பதிப்புகள், எ.கா., 3.14.0) தவிர்க்குமாறு நாங்கள் பரிந்துரைக்கிறோம். ஏனெனில், விண்டோஸில் பைத்தானை ஆதரிக்கத் தேவையான கருவிகள், சமீபத்தில் வெளியிடப்பட்ட நிலையான பைத்தான் பதிப்புகளுக்குப் பொதுவாகக் கிடைப்பதில்லை அல்லது தாமதமாகக் கிடைக்கின்றன.
உங்கள் மேம்பாட்டுச் சூழலை அமைக்கவும்¶
BeeWare Docs Tools-க்கான உங்கள் மேம்பாட்டுச் சூழலை அமைப்பதற்கான பரிந்துரைக்கப்பட்ட வழி, ஒரு மெய்நிகர்ச் சூழலைப் பயன்படுத்தி, பின்னர் BeeWare Docs Tools-இன் மேம்பாட்டுப் பதிப்பையும் அதன் சார்புநிலைத் தொகுப்புகளையும் நிறுவுவதாகும்.
BeeWare Docs Tools களஞ்சியத்தை நகலெடுக்கவும்¶
அடுத்து, GitHub-இல் உள்ள BeeWare Docs Tools பக்கத்திற்குச் செல்லவும், மேலும், நீங்கள் ஏற்கனவே செய்யவில்லை என்றால், கிடங்கை உங்கள் கணக்கில் ஃபோர்க் செய்யவும். அடுத்து, உங்கள் ஃபோர்க்கில் உள்ள "<> Code" பொத்தானைக் கிளிக் செய்யவும். உங்கள் கணினியில் GitHub டெஸ்க்டாப் பயன்பாடு நிறுவப்பட்டிருந்தால், நீங்கள் "Open with GitHub Desktop" என்பதைத் தேர்ந்தெடுக்கலாம்; இல்லையெனில், வழங்கப்பட்ட HTTPS URL-ஐ நகலெடுத்து, கட்டளை வரியைப் பயன்படுத்தி உங்கள் கணினிக்கு ரெபாசிட்டரியைக் குளோன் செய்ய அதைப் பயன்படுத்தவும்:
BeeWare Docs Tools களஞ்சியத்தை ஃபோர்க் செய்து, பின்னர்:
$ git clone https://github.com/<உங்கள் பயனர் பெயர்>/beeware-docs-tools.git
(உங்கள் GitHub பயனர் பெயரை இங்கே மாற்றவும்)
BeeWare Docs Tools களஞ்சியத்தை ஃபோர்க் செய்து, பின்னர்:
$ git clone https://github.com/<உங்கள் பயனர் பெயர்>/beeware-docs-tools.git
(உங்கள் GitHub பயனர் பெயரை இங்கே மாற்றவும்)
BeeWare Docs Tools களஞ்சியத்தை ஃபோர்க் செய்து, பின்னர்:
C:\...>git clone https://github.com/<உங்கள் பயனர் பெயர்>/beeware-docs-tools.git
(உங்கள் GitHub பயனர் பெயரை இங்கே மாற்றவும்)
மேல்நிலை களஞ்சியத்தை அமைக்கவும்¶
உங்கள் ஃபோர்க்கை கிளோன் செய்த பிறகு, BeeWare ரெபாசிட்டரியை ஒரு upstream ரிமோட்டாகச் சேர்க்கவும். இது உங்கள் உள்ளூர் கிளோனுக்கு அசல் ரெபாசிட்டரியின் ஒரு குறிப்பை வழங்குகிறது, காலப்போக்கில் புதுப்பிப்புகளை ஒத்திசைப்பதை எளிதாக்குகிறது.
Toga மற்றும் Briefcase போன்ற கருவிகள் துல்லியமான பதிப்பு எண்களைத் தீர்க்க upstream இலிருந்து வரும் டேக்குகளும் உங்களுக்குத் தேவைப்படும்:
$ git remote add upstream https://github.com/beeware/beeware-docs-tools.git
$ git fetch --tags upstream
$ git remote add upstream https://github.com/beeware/beeware-docs-tools.git
$ git fetch --tags upstream
C:\...>git remote add upstream https://github.com/beeware/beeware-docs-tools.git
C:\...>git fetch --tags upstream
உங்கள் ஃபோர்க்கிலும் அந்த டேக்குகளைச் சேர்க்க விரும்பினால், அவற்றை நீங்கள் புஷ் செய்யலாம்:
$ கிட் புஷ் --டேக்ஸ்
நீங்கள் பின்னர் ஒரு புதிய கிளைனை உருவாக்கி, உங்கள் ஃபோர்க்கிலிருந்து டேக்குகள் கிடைக்க வேண்டும் என்று விரும்பினால் இது பயனுள்ளதாக இருக்கும்.
ஒரு மெய்நிகர் சூழலை உருவாக்கவும்¶
மெய்நிகர் சூழலை அமைக்க மற்றும் மேம்படுத்த pip, பின்வருவனவற்றை இயக்கவும்:
$ cd beeware-docs-tools
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
$ cd beeware-docs-tools
$ python3 -m venv .venv
$ source .venv/bin/activate
(.venv) $ python -m pip install -U pip
C:\...>cd beeware-docs-tools
C:\...>py -3 -m venv .venv
C:\...>.venv\Scripts\activate
(.venv) $ python -m pip install -U pip
உங்கள் கட்டளையின் முன்னால் இப்போது ஒரு (.venv) முன்னொட்டு இருக்க வேண்டும்.
நிறுவவும் BeeWare Docs Tools¶
இப்போது உங்களிடம் மூலக் குறியீடு இருப்பதால், உங்கள் மேம்பாட்டுச் சூழலில் (https://setuptools.pypa.io/en/latest/userguide/development_mode.html) ஐ ஒரு [திருத்தக்கூடிய நிறுவல்]BeeWare Docs Tools செய்யலாம். பின்வரும் கட்டளையை இயக்கவும்:
(.venv) $ python -m pip install -U -e . --group dev
(.venv) $ python -m pip install -U -e . --group dev
(.venv) C:\...>python -m pip install -U -e . --group dev
முன்-அர்ப்பணிப்பை இயக்கவும்¶
BeeWare Docs Tools எளிமையான சிக்கல்களைக் கண்டறியவும், குறியீட்டு வடிவமைப்பைத் தரப்படுத்தவும் pre-commit என்ற கருவியைப் பயன்படுத்துகிறது. எந்தவொரு git commit-ஐயும் இறுதி செய்வதற்கு முன்பு, தானாகவே தொடர்ச்சியான code linters-களை இயக்கும் ஒரு git hook-ஐ நிறுவுவதன் மூலம் இது செயல்படுகிறது. pre-commit-ஐ இயக்க, பின்வருவனவற்றை இயக்கவும்:
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) $ pre-commit install
pre-commit installed at .git/hooks/pre-commit
(.venv) C:\...>pre-commit install
pre-commit installed at .git/hooks/pre-commit
இப்போது நீங்கள் BeeWare Docs Tools ஹேக்கிங் செய்யத் தயாராக உள்ளீர்கள்!