2010-01-25 4 views
7

मेरा एक पैकेज के लिए, मेरे पास एक README.rst फ़ाइल है जो setup.py के लंबे विवरण में पढ़ी जाती है जैसे:मैं इस लंबी_डिस्क्रिप्शन और रीडमे को कुछ वाक्यों से अलग कैसे कर सकता हूं?

readme = open('README.rst', 'r') 
README_TEXT = readme.read() 
readme.close() 

setup(
    ... 
    long_description = README_TEXT, 
    .... 
    ) 

इस तरह से मैं अपने github page पर रीडमे फ़ाइल दिखा सकता हूं जब मैं python setup.py register हर बार pypi page पर प्रतिबद्ध करता हूं और करता हूं। केवल एक समस्या है। मैं जिथब पेज को कुछ ऐसा कहूंगा जैसे "यह दस्तावेज़ envbuilder के प्री-रिलीज संस्करण को प्रतिबिंबित करता है। सबसे हालिया रिलीज के लिए, pypi देखें।"

मैं केवल उन पंक्तियों को README.rst में डाल सकता हूं और python setup.py register से पहले उन्हें हटा सकता हूं, लेकिन मुझे पता है कि एक ऐसा समय होने जा रहा है जब मैं पाइप को धक्का देने से पहले वाक्यों को हटाना भूल जाता हूं।

मैं इसे स्वचालित करने का सबसे अच्छा तरीका सोचने की कोशिश कर रहा हूं इसलिए मुझे इसके बारे में चिंता करने की ज़रूरत नहीं है। क्या किसी के भी पास कोई सुझाव है? क्या कोई सेटअपटोल/डिस्ट्यूट्स जादू है जो मैं कर सकता हूं?

उत्तर

8

तुम बस की तरह "यहाँ विभाजित" कुछ पाठ के साथ एक आराम टिप्पणी उपयोग कर सकते हैं, और फिर अपने setup.py में उस पर अलग हो गए। इयान बाइकिंग वर्चुअलएव में index.txt और setup.py के साथ करता है।

+0

यह हुआ कि मैंने क्या किया। धन्यवाद! –

2

तुम हमेशा ऐसा कर सकता है:

GITHUB_ALERT = 'This document reflects a pre-release version...' 
readme = open('README.rst', 'r') 
README_TEXT = readme.read().replace(GITHUB_ALERT, '') 
readme.close() 

setup(
    ... 
    long_description = README_TEXT, 
    .... 
    ) 

लेकिन तब आप README की वास्तविक शब्दों के साथ सिंक में है कि GITHUB_ALERT स्ट्रिंग रखने के लिए होगा। इसके बजाए एक नियमित अभिव्यक्ति का उपयोग करना (कहने के लिए, से शुरू होने वाली रेखा से मेल करें गिटूब उपयोगकर्ताओं के लिए नोट: या कुछ) आपको थोड़ा अधिक लचीलापन दे सकता है।

+0

इस तरह से ऐसा करने का विचार नहीं किया था। मैं इसे आज़माउंगा। –

5

एक और विकल्प यह है कि दोनों वातावरण में काम करने वाले पैराग्राफ को जोड़कर पूरी तरह से समस्या को हल करना है: "नवीनतम अस्थिर कोड जिथब पर है। नवीनतम स्थिर किट पीपीआई पर हैं।"

आखिरकार, मान लीजिए कि पीपीआई लोग जिथब की ओर इशारा नहीं करना चाहते हैं? यह दोनों दर्शकों के लिए और अधिक सहायक होगा, और आपके setup.py को सरल बनाता है।

+0

दोनों संस्करणों को स्थापित करने के लिए निर्देश हैं। यह के रूप में यह किसी को एक 'easy_install envbuilder' करने के बारे में है pypi लोगों GitHub की ओर इशारा किया पाने के लिए नहीं चाहते, तो GitHub पर प्रलेखन (जो विकास संस्करण के लिए होगा) को देख और सोच क्यों यह काम नहीं कर रहा बारे में के रूप में ज्यादा नहीं है। उस ने कहा, मुझे लगता है कि मैं * स्थिर और अस्थिर संस्करण कहां से थोड़ा और स्पष्ट हो सकता हूं। –

संबंधित मुद्दे

 संबंधित मुद्दे