अजगर के विभिन्न संस्करणों के लिए समर्थन के साथ सही पिपी पैकेज विकसित करना

यह एक छोटा मैनुअल / कहानी है कि अजगर के लिए "सही" पीपीआई पैकेज कैसे बनाया जाए, जिसे कोई भी पोषित कमांड के साथ स्थापित कर सकता है:

pip install my-perfect-package 

यह शुरुआती लोगों के लिए लक्षित है, लेकिन मैं पेशेवरों से "सही" पैकेज को बेहतर बनाने के बारे में अपनी राय व्यक्त करने का आग्रह करता हूं। इसलिए, मैं बिल्ली के लिए पूछना।

"आदर्श" पैकेज का क्या अर्थ है?

मैं निम्नलिखित आवश्यकताओं से आगे बढ़ूंगा:

• गीथुब पर खुला स्रोत;
  हर कोई विकास में योगदान देने और लेखक को धन्यवाद देने में सक्षम होना चाहिए।
• अजगर के सभी वर्तमान / लोकप्रिय संस्करणों के लिए समर्थन (2.7, 3.5, 3.6, 3.7, 3.8);
  अजगर अलग हैं, और कहीं न कहीं अभी भी 2.7 पर सक्रिय रूप से लिखते हैं।
• यूनिट परीक्षणों के साथ 100% कवरेज;
  यूनिट परीक्षण वास्तुकला में सुधार करते हैं और प्रतिगमन जांच को स्वचालित करते हैं।
  पोषित संख्या के साथ एक बैज अक्सर पूछे जाने वाले प्रश्न उठाता है और दूसरों के लिए बार सेट करता है ।
• CI का उपयोग करना:
  स्वचालित जाँच बहुत सुविधाजनक है! और शांत बैज का एक गुच्छा
  
  • सभी प्लेटफार्मों पर और अजगर के सभी संस्करणों पर रनिंग यूनिट परीक्षण;
    उन लोगों पर विश्वास न करें जो दावा करते हैं कि अजगर और स्थापित पैकेज क्रॉस-प्लेटफॉर्म हैं , क्योंकि आप हमेशा एक बग भर में आ सकते हैं।
  • स्टाइल कोड की जांच;
    एक समान शैली पठनीयता में सुधार करती है और एक समीक्षा में खाली चर्चाओं की संख्या को कम करती है।
  • स्टेटिक कोड विश्लेषक;
    कोड में बग के लिए स्वचालित खोज? मुझे दो!
• वास्तविक प्रलेखन;
  पैकेज के साथ काम करने के उदाहरण, विधियों / कक्षाओं का विवरण और विशिष्ट त्रुटियों का विश्लेषण - दस्तावेज अनुभव शुरुआती लोगों के लिए प्रवेश सीमा को कम करेगा।
• क्रॉस-प्लेटफॉर्म विकास;
  दुर्भाग्य से, केवल परियोजनाओं के लिए एक व्यक्तिगत योगदान करना मुश्किल है क्योंकि डेवलपर ने यूनिक्स के लिए उपकरण तेज कर दिए हैं। उदाहरण के लिए, मैंने असेंबली के लिए बैश स्क्रिप्ट का उपयोग किया।
• पैकेज उपयोगी है और दुनिया को एक बेहतर स्थान बनाता है।
  एक कठिन आवश्यकता, पीपीपी (~ 210k) में पैकेजों की संख्या को देखते हुए , डेवलपर्स जंगली परोपकारी हैं और बहुत पहले ही लिखा जा चुका है।

कहाँ से शुरू करें?

अच्छे विचार नहीं थे, इसलिए मैंने एक हैकनीड और बहुत लोकप्रिय विषय चुना - नंबर सिस्टम के साथ काम करना। पहला संस्करण रोमन और इसके विपरीत संख्याओं का अनुवाद करने में सक्षम होना चाहिए। मैनुअल के लिए अधिक जटिल है और आवश्यक नहीं है। अरे हाँ, सबसे महत्वपूर्ण नाम है: numsys - अंक प्रणाली के डिक्रिप्शन के रूप में। numeral-system-py ।

कैसे करें टेस्ट?

मैंने python3.7 लिया और पहले मानक unittests मॉड्यूल का उपयोग करके फ़ंक्शन स्टब्स (हम सभी TDDs हैं ) के साथ परीक्षण लिखा।

मैं निम्नलिखित परियोजना संरचना बनाता हूं:

 src/ numeral-system/ __init__.py roman.py tests __init__.py test_roman.py 

मैंने पैकेज में परीक्षण नहीं किए हैं, इसलिए मैं अलग हूं भूसा से गेहूं । प्रारंभ में, src/ folder नहीं बनाया, लेकिन आगे के विकास से पता चला कि यह मेरे लिए संचालित करने के लिए अधिक सुविधाजनक है। इसलिए, यह आवश्यक नहीं है।

मैंने लॉन्च के लिए पाइस्टेस्ट का उपयोग करने का फैसला किया - यह जानता है कि मानक मॉड्यूल से परीक्षणों के साथ पूरी तरह से कैसे काम किया जाए। यह थोड़ा अतार्किक लग सकता है, लेकिन मेरे लिए परीक्षण का मानक मॉड्यूल है ऐसा लगता है थोड़ा और सहज लग रहा था। अब मैं लिखने की पूरी शैली का उपयोग करने की सलाह दूंगा।

लेकिन, वे कहते हैं कि सिस्टम अजगर में pytest (किसी भी अन्य निर्भरता की तरह) pytest बहुत स्मार्ट विचार नहीं है ...

निर्भरता कैसे प्रबंधित करें?

केवल virtualenv और requirements.txt का उपयोग किया जा सकता है। आप प्रगतिशील हो सकते हैं और कविता का उपयोग कर सकते हैं। मैं, शायद, विषाक्त का उपयोग करूँगा - स्वचालन और परीक्षण को आसान बनाने के लिए एक उपकरण, जो मुझे निर्भरता का प्रबंधन करने की भी अनुमति देगा।

मैं एक साधारण टॉक्सि.इन कॉन्फिगर बनाता हूं और pytest स्थापित करता pytest :

 [tox] envlist = py37 ;     ,   python3.7 [testenv] ;     deps =  `deps`  ,   . -r requirements.txt ;     -r requirements-test.txt ; commands = pytest ;   

प्रारंभ में, मैंने स्पष्ट रूप से निर्भरता का संकेत दिया था, लेकिन तीसरे पक्ष की सेवाओं के साथ एकीकरण के अभ्यास से पता चला कि सबसे अच्छा तरीका अभी भी requirements.txt में निर्भरता को संग्रहीत करना होगा। फ़ाइल में।

बहुत सूक्ष्म क्षण पैदा होता है। विकास के समय वर्तमान संस्करण को ठीक करें या हमेशा नवीनतम रखें?

यदि आप प्रतिबद्ध हैं, तो स्थापना के दौरान उपयोग किए गए निर्भरता के विभिन्न संस्करणों के कारण संकुल के बीच संघर्ष हो सकता है। यदि आप प्रतिबद्ध नहीं हैं, तो पैकेज अचानक काम करना बंद कर सकता है। अंतिम स्थिति अंतिम उत्पादों के लिए बहुत अप्रिय है, जब अंतर्निहित निर्भरता के मामूली अद्यतन के कारण सभी बिल्ड एक रात में "लाल हो जाते हैं"। और मर्फी के नियम के अनुसार, यह रिलीज के दिन होगा।

इसलिए, मैंने अपने लिए एक नियम विकसित किया:

1. हमेशा अंतिम उत्पादों के लिए संस्करण को ठीक करें, जिसके बाद से संस्करणों का उपयोग करना उनकी जिम्मेदारी है।
2. इंस्टॉल किए गए पैकेज के लिए उपयोग किए गए संस्करण को ठीक न करें। या इसे एक सीमा तक सीमित करें यदि पैकेज की कार्यक्षमता के लिए इसकी आवश्यकता होती है।

आगे क्या है?

मैं परीक्षण लिख रहा हूँ!

मैं फ़ंक्शन के शरीर में भरता हूं, टिप्पणियां जोड़ता हूं और परीक्षण सही ढंग से चलाता हूं।
इस बिंदु पर, अधिकांश डेवलपर्स आमतौर पर बंद हो जाते हैं (मुझे अभी भी विश्वास है कि हर कोई परीक्षण = लिखता है), पैकेज और हैक बग प्रकाशित करें। लेकिन मैं आगे बढ़ता हूं और खरगोश छेद में कूदो ।

अजगर के विभिन्न संस्करणों के साथ कैसे काम करें?

tox विन्यास में, tox अजगर के सभी दिलचस्प संस्करणों पर परीक्षणों की शुरूआत निर्दिष्ट करता tox :

 [tox] envlist = py{27,35,36,37,38} 

पाइनेव का उपयोग करते हुए, मैं स्थानीय रूप से अपने लिए आवश्यक संस्करण वितरित करता हूं ताकि विषाक्त उन्हें खोज सकें और परीक्षण वातावरण बना सकें।

पोषित 100% कहां हैं?

मैं कोड के कवरेज का एक माप जोड़ूंगा - इसके लिए एक उत्कृष्ट कवरेज पैकेज है और पाइस्टेस्ट - पाइस्टेस्ट-कोव के साथ कोई कम उत्कृष्ट एकीकरण नहीं है।
requirements-test.txt अब इस तरह दिखता है:

 six=1.13.0 pytest=4.6.7 pytest-cov=2.8.1 parameterized=0.7.1 

उपरोक्त नियम के अनुसार, मैं उन पैकेजों के संस्करणों को ठीक करता हूं जो परीक्षण चलाने के लिए उपयोग किए जाते हैं।

मैं टेस्ट रन कमांड बदलता हूं:

 deps = -r requirements.txt -r requirements-test.txt commands = pytest \ --cov=src/ \ --cov-config="{toxinidir}/tox.ini" \ --cov-append 

मैं src/ folder - संकुल स्वयं ( numeral_system / ) और परीक्षण कोड ( परीक्षणों / ) के लिए आवश्यक सभी कोड के लिए कवरेज के आँकड़े एकत्र कर रहा हूँ - मैं नहीं चाहता कि परीक्षण स्वयं गैर-निष्पादन योग्य भागों को शामिल करें?

कमांड --cov-append एक कॉल के लिए एकत्र किए गए सभी आँकड़ों को एक अलग संस्करण में अजगर के तहत एक में --cov-append करता --cov-append , क्योंकि दूसरे और तीसरे अजगर के लिए कवरेज अलग-अलग हो सकता है (हाय संस्करण-निर्भर कोड और मॉड्यूल छह !), लेकिन कुल में 100 देते हैं! %। एक सरल उदाहरण:

 if sys.version_info > (3, 0): # Python 3 code in this block else: # Python 2 code in this block 

एक कवरेज रिपोर्ट बनाने के लिए एक नया वातावरण जोड़ें।

 [testenv:coverage_report] deps = coverage commands = coverage html ;   ,   coverage report --include="src/*" --fail-under=100 -m ;    100%  

और मैं अजगर के सभी संस्करणों पर परीक्षण चलाने के बाद वातावरण की सूची में जोड़ता हूं।

 [tox] envlist = py{27,35,36,37,38} coverage_report 

tox कमांड को चलाने के बाद, एक सुंदर रिपोर्ट के साथ index.html फ़ाइल युक्त tox फ़ोल्डर प्रोजेक्ट रूट में दिखाई देना चाहिए।

प्रतिष्ठित बैज के लिए, मैं कोडकोव सेवा के साथ 100% एकीकृत करता हूं , जो खुद पहले से ही जीथब के साथ एकीकृत होगा और आपको कोड कवरेज परिवर्तनों के इतिहास को देखने की अनुमति देगा। इसके लिए, निश्चित रूप से, आपको वहां एक खाता बनाना होगा।

अंतिम लॉन्च वातावरण इस प्रकार है:

 [testenv:coverage_report] deps = coverage==5.0.2 codecov==2.0.15 commands = coverage html coverage report --include="src/*" --fail-under=100 -m coverage xml codecov -f coverage.xml --token=2455dcfa-f9fc-4b3a-b94d-9765afe87f0f ;     codecov,    

यह अब केवल README.rst में बैज के लिए एक लिंक जोड़ने के लिए बनी हुई है:

 |Code Coverage| .. |Code Coverage| image:: https://codecov.io/gh/zifter/numeral-system-py/branch/master/graph/badge.svg :target: https://codecov.io/gh/zifter/numeral-system-py 

कोड का प्रारूप और विश्लेषण कैसे करें?

कई विश्लेषक मौजूद नहीं हैं, क्योंकि वे, अधिकांश भाग के लिए, एक दूसरे के पूरक हैं। इसलिए, मैं लोकप्रिय स्थिर विश्लेषणकर्ताओं को एकीकृत करूंगा जो पीईपी 8 के अनुपालन की जांच करेंगे, संभावित समस्याओं का पता लगाएंगे और सभी कीड़े को ठीक करें समान रूप से कोड को प्रारूपित करें।

आपको तुरंत विचार करना चाहिए कि विश्लेषणकर्ताओं को ठीक करने के लिए मापदंडों को कहां निर्दिष्ट करना है। ऐसा करने के लिए, आप tox.ini फ़ाइल, setup.cfg , एक एकल कस्टम फ़ाइल या विश्लेषणकर्ताओं के लिए विशिष्ट फ़ाइलों का उपयोग कर सकते हैं। मैंने सीधे tox.ini का उपयोग करने का निर्णय लिया है, क्योंकि आप भविष्य की परियोजनाओं के लिए बस tox.ini नकल कर सकते हैं।

isort

आयात आयात करने के लिए isort एक उपयोगिता है।

मैं कोड प्रारूप मोड में isort चलाने के लिए निम्न वातावरण isort ।

 [testenv:isort] changedir = {toxinidir}/src deps = isort==4.3.21 commands = isort -y -sp={toxinidir}/tox.ini 

दुर्भाग्य से, isort प्रारूपण के लिए एक फ़ोल्डर निर्दिष्ट नहीं कर सकता है। इसलिए, आपको स्टार्टअप निर्देशिका को changedir माध्यम से changedir और सेटिंग्स -sp={toxinidir}/tox.ini साथ फ़ाइल को पथ निर्दिष्ट करना -sp={toxinidir}/tox.ini । इंटरैक्टिव मोड को निष्क्रिय करने के लिए -y स्विच की आवश्यकता होती है।

परीक्षणों में चलाने के लिए, आपको एक सत्यापन मोड की आवश्यकता है - इसके लिए एक --check-only ध्वज है:

 [testenv:isort-check] changedir = {toxinidir}/src deps = isort==4.3.21 commands = isort --check-only -sp={toxinidir}/tox.ini 

काला

अगला, मैं ब्लैक कोड फॉर्मेटर के साथ एकीकृत करता हूं। मैं इसे isort साथ सादृश्य द्वारा करता isort :

 [testenv:black] deps = black==19.10b0 commands = black src/ [testenv:black-check] deps = black==19.10b0 commands = black --check src/ 

सब कुछ अच्छी तरह से काम करता है, लेकिन isort साथ एक संघर्ष है - आयात के प्रारूपण में अंतर है।

टिप्पणियों में से एक में मुझे एक न्यूनतम संगत isort सेटिंग isort , जिसका मैंने उपयोग किया:

 [isort] multi_line_output=3 include_trailing_comma=True force_grid_wrap=0 use_parentheses=True line_length=88 

flake8

इसके बाद, मैं flake8 स्थिर विश्लेषक के साथ एकीकृत करता हूं ।

 [testenv:flake8-check] deps = flake8==3.7.9 commands = flake8 --config=tox.ini src/ 

फिर से black साथ एकीकरण की समस्याएं हैं। हमें एक ठीक ट्यूनिंग जोड़ना होगा, जो वास्तव में, black द्वारा ही अनुशंसित है:

 [flake8] max-line-length=88 ignore=E203 

दुर्भाग्य से, पहली बार इसने काम नहीं किया। E231 missing whitespace after ',' त्रुटि के साथ फेल हो E231 missing whitespace after ',' , मुझे इस त्रुटि को अनदेखा करना पड़ा:

 [flake8] max-line-length=88 ignore=E203,E231 

pylint

पाइलिंट स्थिर कोड analyzers के साथ एकीकृत

 [testenv:pylint-check] deps = {[testenv]deps} # pylint  ,     pylint==2.4.4 commands = pylint --rcfile=tox.ini src/ 

मैं तुरंत अजीब प्रतिबंधों में आता हूं - 30 अक्षरों के फ़ंक्शन नाम (हां, मैं परीक्षण विधियों के बहुत लंबे नाम लिखता हूं) और कोड में TODO की उपस्थिति के लिए चेतावनी।
मुझे कुछ अपवादों को जोड़ना है:

 [MESSAGES CONTROL] disable=fixme,invalid-name 

इसके अलावा, अप्रिय क्षण यह है कि pylint डेवलपर्स pylint ही python2.7 दफन कर python2.7 और अब इसके लिए पैकेज विकसित नहीं कर रहे हैं। इसलिए, चेक को मौजूदा पैकेज पर python3.7 लिए चलाया जाना चाहिए।
कॉन्फ़िगरेशन के लिए उपयुक्त पंक्ति जोड़ें:

 [tox] envlist = isort-check black-check flake8-check pylint-check py{27,35,36,37,38} coverage_report basepython = python3.7 

यह विभिन्न प्लेटफार्मों पर परीक्षण चलाने के लिए भी महत्वपूर्ण है, क्योंकि सीआई सिस्टम में अजगर का डिफ़ॉल्ट संस्करण अलग है।

CI के साथ क्या हो रहा है?

Appveyor

एप्वाइटर के साथ एकीकृत करें - विंडोज़ के लिए CI। प्रारंभिक सेटअप सरल है - इंटरफ़ेस में सब कुछ किया जा सकता है, फिर yaml फ़ाइल डाउनलोड करें और इसे रिपॉजिटरी में करें।

 version: 0.0.{build} install: - cmd: >- C:\\Python37\\python -m pip install --upgrade pip C:\\Python37\\pip install tox build: off test_script: - cmd: C:\\Python37\\tox 

यहां मैं स्पष्ट रूप से python3.7 के संस्करण को निर्दिष्ट करता python3.7 , क्योंकि python2.7 डिफ़ॉल्ट रूप से उपयोग किया जाएगा (और python2.7 भी इस संस्करण का उपयोग करेगा, हालांकि मैंने स्पष्ट रूप से python3.7 निर्दिष्ट python3.7 )।
बैज का लिंक, हमेशा की तरह, README.rst जोड़ा गया है

 |Build status Appveyor| .. |Build status Appveyor| image:: https://ci.appveyor.com/api/projects/status/github/zifter/numeral-system-py?branch=master&svg=true :target: https://ci.appveyor.com/project/zifter/numeral-system-py 

ट्रैविस सी.आई.

उसके बाद, मैं ट्रैविस CI - CI को लिनक्स के तहत (और विंडोज के साथ मैकओएस के तहत एकीकृत करता हूं, लेकिन Python builds are not available on the macOS and Windows environments । सेटअप थोड़ा अधिक जटिल है, क्योंकि कॉन्फ़िगरेशन फ़ाइल को रिपॉजिटरी से सीधे उपयोग किया जाएगा। परीक्षण और त्रुटि पुनरावृत्तियों के एक जोड़े। कॉन्फ़िगरेशन तैयार है, मैं एक सुंदर प्रतिबद्ध में स्क्वैश करता हूं और मर्ज अनुरोध तैयार है।

 language: python python: 3.8 # dist: xenial # required for Python 3.7 (travis-ci/travis-ci#9069) sudo: required # required for Python 3.7 (travis-ci/travis-ci#9069) addons: apt: sources: - deadsnakes packages: - python3.5 - python3.6 - python3.7 - pypy install: - pip install tox script: - tox 

( बयानबाजी का सवाल: और CI प्रोजेक्ट्स जैसे याम्ल फॉर्मेट को इतना पसंद क्यों करते हैं? )

मैं python3.8 के संस्करण को इंगित करता python3.8 , क्योंकि यह addon माध्यम से सही ढंग से काम नहीं करता है, और Travis CI सफलतापूर्वक निर्दिष्ट संस्करण से python3.8 बनाता है।

Travis CI परिचित लोग पूछ सकते हैं, क्यों नहीं स्पष्ट रूप से अजगर संस्करणों को इस तरह निर्दिष्ट करें? आखिरकार, Travis CI स्वतः ही virtualenv बनाता है और इसमें आवश्यक कमांड निष्पादित करता है।

कारण यह है कि हमें सभी संस्करणों से कोड कवरेज डेटा एकत्र करने की आवश्यकता है। लेकिन परीक्षण समानांतर में विभिन्न नौकरियों में चलाए जाएंगे, यही कारण है कि यह सामान्य कवरेज रिपोर्ट एकत्र करने के लिए काम नहीं करेगा।

बेशक, मुझे यकीन है कि थोड़ी और समझ है और इसे ठीक किया जा सकता है।

परंपरा के अनुसार, बैज का लिंक README.rst में भी जोड़ा जाता है

 |Build Status Travis CI| .. |Build Status Travis CI| image:: https://travis-ci.org/zifter/numeral-system-py.svg?branch=master :target: https://travis-ci.org/zifter/numeral-system-py 

प्रलेखन

मुझे लगता है कि हर अजगर डेवलपर ने कम से कम एक बार सेवा का उपयोग किया है - readthedocs.org । यह मुझे लगता है कि यह अपने प्रलेखन की मेजबानी के लिए सबसे अच्छी सेवा है।
मैं स्फिंक्स प्रलेखन उत्पन्न करने के लिए मानक उपकरण का उपयोग करूंगा। मैं शुरुआती मैनुअल से चरणों का पालन करता हूं और निम्नलिखित संरचना प्राप्त करता हूं:

 src/ docs/ build/ #      html  source/ #     _static/ #   , ,  _templates/ #     conf.py #    index.rst #    make.bat Makefile # make     make 

अगला, आपको कॉन्फ़िगर करने के लिए न्यूनतम चरण करने की आवश्यकता है:

1. डिफ़ॉल्ट रूप से github README.md प्रारूप में एक README.md फ़ाइल बनाने का सुझाव देता है, जब डिफ़ॉल्ट रूप से sphinx रूप में यह ReStructuredText का उपयोग करने का सुझाव देता है ।

इसलिए, मुझे इसे .rst प्रारूप में फिर से लिखना पड़ा। और अगर मैंने कम से कम एक बार स्टार्ट मैनुअल को पढ़ा था, तो मैंने महसूस किया कि sphinx इसे मार्कडाउन में कर सकता है ।
मैं README.rst फ़ाइल को index.rst में README.rst index.rst

 .. include:: ../../README.rst 

1. स्रोत में टिप्पणियों से दस्तावेज़ उत्पन्न करने के लिए, मैं एक्सटेंशन sphinx.ext.autodoc जोड़ता हूं ।
2. मैं पैकेज फ़ोल्डर को conf.py यह sphinx को विश्लेषण के लिए हमारे कोड को आयात करने की अनुमति देगा।
   

    import os import sys sys.path.insert(0, os.path.abspath('./../../src')) import numeral_system 

3. मैं docs/source/api-docs फ़ोल्डर जोड़ता हूं और वहां प्रत्येक मॉड्यूल के लिए विवरण फ़ाइल को छोड़ देता हूं। दस्तावेज़ीकरण को स्वचालित रूप से टिप्पणियों से उत्पन्न किया जाना चाहिए:
   

    Roman numeral system ========================= .. automodule:: numeral_system.roman :members: 

उसके बाद, परियोजना दुनिया के लिए अपने विवरण को प्रकट करने के लिए तैयार है। आपको एक खाता बनाने की ज़रूरत है (अधिमानतः github पर एक खाते के माध्यम से) और अपनी परियोजना को आयात करें, विस्तृत चरणों को निर्देशों में वर्णित किया गया है।
परंपरा से, मैं tox वातावरण बनाता हूं:

 [testenv:gen_docs] deps = -r docs/requirements.txt commands = sphinx-build -b html docs/source/ docs/build/ 

मैं sphinx-build उपयोग स्पष्ट रूप से करता हूं, बजाय make , क्योंकि यह विंडोज के तहत मौजूद नहीं है। और मैं क्रॉस-प्लेटफॉर्म विकास के सिद्धांत का उल्लंघन नहीं करना चाहता।

जैसे ही परिवर्तन जमे हुए हैं, readthedocs.org स्वचालित रूप से प्रलेखन एकत्र करेगा और इसे प्रकाशित करेगा।

लेकिन ... Build failed । मैंने sphinx और sphinx_rtd_theme , और मुझे वर्तमान संस्करणों readthedocs.org लेने के readthedocs.org की readthedocs.org । लेकिन ऐसा है नहीं। मैं ठीक करता हूँ:

 sphinx==2.3.1 sphinx_rtd_theme==0.4.3 

और मैं .readthedocs.yml लिए एक विशेष कॉन्फ़िगरेशन फ़ाइल .readthedocs.yml readthedocs.org , जिसमें मैं बिल्ड लॉन्च करने के लिए पर्यावरण का वर्णन करता हूं:

 python: version: 3.7 install: - requirements: docs/requirements.txt - requirements: requirements.txt 

यह वह जगह है जहाँ यह तथ्य काम में आया है कि निर्भरता requirements.txt में requirements.txt । मैं निर्माण की प्रतीक्षा कर रहा हूं और दस्तावेज उपलब्ध हो गया है ।

बैज फिर से जोड़ें:

 |Docs| .. |Docs| image:: https://readthedocs.org/projects/numeral-system-py/badge/?version=latest&style=flat :target: https://numeral-system-py.readthedocs.io/en/latest/ 

लाइसेंस

यह पैकेज के लिए लाइसेंस चुनने पर विचार करने के लायक है।
यह एक बहुत व्यापक विषय है, इसलिए मैंने इस लेख को पढ़ा। मूल रूप से, विकल्प एमआईटी और अपाचे 2.0 के बीच है। मुझे वह वाक्यांश पसंद आया जो संदर्भ से सफलतापूर्वक लिया गया था:

 MIT       

मैं पूरी तरह से सहमत हूं, मैं ऐसा करूंगा। यदि योजनाएं बदलती हैं, तो आप आसानी से लाइसेंस बदल सकते हैं (हालांकि पिछले संस्करण पुराने के तहत होंगे)।

फिर, एक बैज जोड़ें बिल्ला भगवान :

 |License| .. |License| image:: https://img.shields.io/badge/License-MIT-yellow.svg :target: https://opensource.org/licenses/MIT 

यहां आप सभी लाइसेंस के लिए बैज पा सकते हैं।

Pypi पर कैसे अपलोड करें?

सबसे पहले आपको pypi.org पर एक खाता बनाना होगा । फिर पैकेज की तैयारी के साथ आगे बढ़ें।

मैं setup.cfg बनाता हूं

पैकेज को स्थापित / बनाने के लिए कॉन्फ़िगरेशन का सही ढंग से वर्णन करना आवश्यक है। मैंने निर्देशों का पालन ​​किया । डेटा को सेटअप setup.py माध्यम से सेट करना संभव है, लेकिन कुछ मापदंडों को सेट करने के लिए कोई विकल्प नहीं है। इसलिए, setup.cfg फ़ाइल का उपयोग करें, जिसमें आप सभी बारीकियों को निर्दिष्ट कर सकते हैं। इस फ़ाइल को कैसे भरें, इसका एक छोटा सा खाका मिला। नतीजतन, मैं उस और उस फ़ाइल दोनों का उपयोग करता हूं - यह अधिक सुविधाजनक है।

इस फ़ाइल का उपयोग pylint , flake8 और अन्य सेटिंग्स को कॉन्फ़िगर करने के लिए भी किया जा सकता है, लेकिन मैंने नहीं किया।

पैकेज कैसे इकट्ठा करें?

फिर से मैं एक वातावरण लिख रहा हूँ जो मुझे एक साथ आवश्यक पैकेज देने में मदद करेगा:

 [testenv:build_wheel] skip_install = True deps = ;     wheel docutils pygments commands = python -c 'import shutil; (shutil.rmtree(p, ignore_errors=True) for p in ["build", "dist"]);' python setup.py sdist bdist_wheel 

मैं अजगर का उपयोग करके फ़ोल्डर्स को क्यों हटा रहा हूं? मैं क्रॉस-प्लेटफॉर्म विकास के लिए आवश्यकता का अनुपालन करना चाहता हूं, विंडोज और यूनिक्स के तहत ऐसा करने का कोई सुविधाजनक तरीका नहीं है।

मैं परीक्षण वातावरण लॉन्च करता हूं:

 tox -e build_wheel 

परिणामस्वरूप, मुझे मिले फ़ोल्डर में:

 dist/ numeral-system_py-0.1.0.tar.gz numeral_system-py-0.1.0-py2.py3-none-any.whl 

मैं भरता हूँ!

वास्तव में नहीं।

शुरू करने के लिए, यह जांचने योग्य है कि पैकेज सही तरीके से काम करता है। मैं इसे परीक्षण पैकेज रिपॉजिटरी में अपलोड करूंगा। इसलिए, आपको एक और खाता बनाने की आवश्यकता है, लेकिन पहले से ही test.pypi.org पर।

मैं इसके लिए सुतली पैकेज का उपयोग करता हूं - PyPi में कलाकृतियों को भरने के लिए एक उपकरण।

 [testenv:test_upload] skip_install = True deps = twine ;    commands = python -m twine upload --repository-url https://test.pypi.org/legacy/ dist/* 

प्रारंभ में, परियोजना को numsys कहा जाता था, लेकिन इसे भरने की कोशिश करते समय, मैं इस तथ्य में भाग गया कि एक ही नाम वाला एक पैकेज पहले से मौजूद है! और जो सबसे अधिक कष्टप्रद है - वह यह भी जानता है कि रोमन अंकों में कैसे परिवर्तित किया जाए :) वह बहुत परेशान नहीं हुआ और नामांकित होकर numeral-system-py ।

अब आपको परीक्षण वातावरण से पैकेज को स्थापित करने की आवश्यकता है। मान्यता भी स्वचालित होनी चाहिए:

 [testenv:test_venv] skip_install = True ;         deps = ;   commands = pip install -i https://test.pypi.org/simple/ numeral-system-py 

अब आपको बस चलाने की आवश्यकता है:

 tox -e test_venv ... test_venv: commands_succeeded congratulations :) 

यह काम करने लगता है :)

अब जरूर डालना!

हां।

मैं उत्पादन रिपॉजिटरी में अपलोड करने के लिए एक वातावरण बनाता हूं।

 [testenv:pypi_upload] skip_install = True deps = twine commands = python -m twine upload dist/* 

और उत्पादन सत्यापन के लिए पर्यावरण।

 [testenv:pypi_venv] skip_install = True deps = ;    commands = pip install numeral-system-py 

सब कुछ काम करता है?

मैं साधारण आदेशों के साथ जाँच करता हूँ:

 > virtualenv venv > source venv/bin/activate (venv) > pip install numeral-system-py (venv) > python >>> import numeral_system >>> numeral_system.roman.encode(7) 'VII' 

सब कुछ बहुत अच्छा है!

मैंने जीथूब पर रिलीज को काट दिया , पैकेज इकट्ठा किया और इसे प्रोपी पिपी में भर दिया।

टिप्पणी

निर्भरता अद्यतन

इस लेख की तैयारी के दौरान, पाइस्टेस्ट का एक नया संस्करण जारी किया गया था, जिसमें, वास्तव में, अजगर 3.4 के लिए समर्थन को गिरा दिया गया था ( वास्तव में कलरमा पैकेज में)। दो विकल्प थे:

1. 3.4 के साथ संगत रंगामा संस्करण;
2. ड्रॉप सपोर्ट 3.4 :)

दूसरे विकल्प के पक्ष में, अंतिम तर्क यह था कि 19.1 संस्करण में pip ने समर्थन 3.4 गिरा दिया।

विश्लेषक, प्रारूपकर्ता और अन्य सेवाओं के रूप में भी निश्चित निर्भरताएं हैं। ये निर्भरताएँ उसी समय अपडेट की जा सकती हैं। यदि आप भाग्यशाली हैं, तो आप केवल अपग्रेड संस्करण के साथ बंद हो जाएंगे; यदि नहीं, तो आपको कोड को सही करना होगा या सेटिंग्स को भी जोड़ना होगा।

TravisCI

MacOS और Windows के लिए अजगर का समर्थन नहीं करता है। एक ही काम के भीतर अजगर के सभी संस्करणों के लिए tox चलाने के साथ कठिनाइयाँ हैं।

पैकेज संस्करण

यह शब्दार्थ संस्करण का पालन करना आवश्यक है, अर्थात् प्रारूप:

 MAJOR.MINOR.PATCH 

मेटा जानकारी का दोहराव

पैकेज का संस्करण और कुछ अन्य मापदंडों को पैकेज ( setup.cfg या setup.py ) और प्रलेखन में स्थापित करने के लिए निर्दिष्ट किया जाना चाहिए। दोहराव से बचने के लिए, उन्होंने केवल पैकेज numeral_system/__init__.py में एक संकेत दिया:

 __version__ = '0.2.0' 

और फिर setup.py स्पष्ट रूप से इस चर का उपयोग करता setup.py

 setup(version=numeral_system.__version__) 

docs/source/conf.py

 release = numeral_system.__version__ 

उपरोक्त किसी भी मेटा जानकारी के लिए सही है - REAMDE.rst , परियोजना विवरण, लाइसेंस, लेखक के नाम, और बहुत कुछ।

सच है, यह इस तथ्य की ओर जाता है कि पैकेज को विधानसभा के समय आयात किया जा रहा है, जो अवांछनीय हो सकता है।

निर्भरता दोहराव

शुरुआत में, मैं इस तथ्य से भ्रमित था कि मुझे आवश्यकताओं में पैकेज के लिए निर्भरता निर्दिष्ट करने की requirements.txt setup.cfg । setup.cfg और setup.cfg । setup.cfg ।
, — setup.cfg .
. , requirements-dev.txt .

, src/ . :

• ;
• , , ;

:

• PyCharm ( ?) — src , .

— .
, :

 Add badge with supported version Support for py38 

:

 Try fix py38 env creating Try fix py38 env creating Try fix py38 env creating Fix check 

, 3 ! Travis CI.

, . — , .

, . CHANGELOG .

, Markdown . , rst .

बैज

— , , , . , .
coverage .

-

, , , . six , , type hint , asyncio — .
python2.7 , . , python3.5+, . , , CI . .

?

, :

• MacOS;
• python x64 x86;
• ;
• 100% , . mccabe , 2017 . ?
• PyUp requires.io . ?
• . Python Code Quality Authority , - ?
  
  • mypy — ;
  • bandit — ;
  • Pyflakes — ;
  • prospector — , pylint , pep8 , mccabe . , ;
• \ ?

निष्कर्ष

open source , .
, python github , .
stackoverflow.com issues github .
. . ?..

, , .
, .

github .

धन्यवाद!