पाठ्यक्रम 250 में से पाठ 242 · कैपस्टोन: भेज दें (अपना प्रोजेक्ट पैक करें)
कैपस्टोन: भेज दें (अपना प्रोजेक्ट पैक करें)

README + एक-command वाला दौर

आपके पास साफ़ ढाँचा और असली टेस्ट हैं। आख़िरी मील वह हिस्सा है जिससे समीक्षक असल में पहले टकराते हैं: README और वह एक command जो चीज़ को चलाता है। जो प्रोजेक्ट शुरू करने में दस मिनट का अंदाज़ा ले वह काम करने पर भी टूटा लगता है। जिस प्रोजेक्ट को आप clone करके एक पंक्ति से चला सकें वह छोटा होने पर भी पेशेवर लगता है। वही कोड -> बिल्कुल अलग छाप।

README एक अनुबंध है। एक पाठक इसे ऊपर से नीचे सरसरी नज़र से पढ़ता है, और एक अनुमान लगाने लायक आकार की उम्मीद करता है: शीर्षक के रूप में प्रोजेक्ट का नाम, फिर इसे कैसे install करें, फिर कैसे इस्तेमाल करें, फिर कैसे टेस्ट करें। ठोस रूप से, एक मज़बूत README में एक ऊपरी शीर्षक पंक्ति (# Something), फिर ये हिस्से इसी क्रम में होते हैं:

# Triage Copilot

## Setup
pip install -e .            # editable install
cp .env.example .env        # then paste your real key into .env

## Usage
python -m triage            # the one-command run

## Tests
pytest

क्रम मायने रखता है क्योंकि पाठक इसे क़दमों के रूप में मानता है। Setup से पहले Usage उलझाता है -> जो install नहीं किया उसे आप इस्तेमाल नहीं कर सकते। इसलिए आप एक जाँचने वाला, validate_readme(text), लिखते हैं जो True सिर्फ़ तब लौटाए जब एक #  शीर्षक आए, उसके बाद ## Setup, फिर ## Usage, फिर ## Tests, हर एक पिछले के बाद। ग़ायब हिस्सा, या बेतरतीब क्रम वाले हिस्से, False लौटाते हैं। तरकीब: पंक्तियों पर एक बार चलें, आप कहाँ हैं इसका एक "cursor" रखें, और हर हिस्से को cursor के बाद वाले स्थान पर आना ज़रूरी करें।

एक-command वाला दौर। ध्यान दें कि ऊपर की ## Usage पंक्ति एक अकेला command है। यह make run जैसे एक Makefile या justfile target का लक्ष्य है -> एक याद रखने लायक command जो प्रोजेक्ट चलाता है, ताकि किसी को पूरा आह्वान याद न रखना पड़े। make_run(name) लिखें जो किसी प्रोजेक्ट के लिए वह command स्ट्रिंग लौटाए, जैसे python -m triage (या make run)। इसमें प्रोजेक्ट का नाम होना चाहिए, package directory की तरह ही सामान्य किया, ताकि अलग प्रोजेक्ट अलग command दे।

असली repo के लिए दो ईमानदार, बिना ग्रेड वाले नोट्स। पहला, secrets: cp .env.example .env क़दम इसलिए है क्योंकि आपकी असली API key .env में जाती है, जिसे आप .gitignore में जोड़ते हैं और कभी commit नहीं करते। आप सिर्फ़ .env.example commit करते हैं -> placeholder मानों के साथ config का आकार। एक key को सार्वजनिक repo में लीक करना portfolio-प्रोजेक्ट की क्लासिक ग़लती है। दूसरा, इसे deploy करना: इसे online रखने के लिए आप एक छोटी Dockerfile लिखेंगे (repo कॉपी करें, pip install, run command को entrypoint के रूप में सेट करें) और Render, Railway, या Fly जैसे PaaS पर push करेंगे। वह हिस्सा आपके ब्राउज़र में न चल सकता है न ग्रेड हो सकता है -> प्रकाशित करते समय वह आपका काम है। एक पूरा README जाँचने और run command print करने के लिए Run दबाएँ।

आपकी बारी

एक अच्छे README के दो निश्चित टुकड़े लिखें। validate_readme(text) True लौटाता है तभी जब एक ऊपरी #  शीर्षक आए, फिर ## Setup, फिर ## Usage, फिर ## Tests, हर एक पिछले के बाद (ग़ायब हिस्सा या बेतरतीब क्रम वाले हिस्से -> False)। make_run(name) एक-command वाली run स्ट्रिंग लौटाता है (जैसे python -m <pkg> या make run) जिसमें प्रोजेक्ट का नाम हो, package dir की तरह सामान्य किया, ताकि अलग नाम अलग command दे।

इस पाठ में कोई समस्या दिखी? बताएँ · इस पाठ के बारे में पूछें

यह अभ्यास जल्द खुलेगा

इससे पहले वाला पाठ पूरा करें और यह खुल जाएगा। पूरा कोर्स मुफ़्त है, कोई खाता नहीं चाहिए, और आप यह पाठ अभी पढ़ सकते हैं।