पायथन मॉड्यूल को व्यवस्थित करने के लिए सर्वोत्तम अभ्यास क्या हैं?

यहाँ एक नमूना प्रोजेक्ट है जो आपकी परियोजनाओं की संरचना करने का एक बहुत अच्छा तरीका दिखाता है:https://github.com/kennethreitz/samplemod। परियोजना "नमूना" मॉड्यूल बनाने के बारे में है। निर्देशिका संरचना इस प्रकार दिखती है:

README.rst
LICENSE
setup.py
requirements.txt
sample/__init__.py
sample/core.py
sample/helpers.py
docs/conf.py
docs/index.rst
tests/test_basic.py
tests/test_advanced.py

README.rst फ़ाइल: यह फ़ाइल मॉड्यूल का संक्षिप्त विवरण देने के लिए है, इसे कैसे सेट अप करें, इसका उपयोग कैसे करें, आदि।

लाइसेंस: लाइसेंस पाठ और कोई भी कॉपीराइट दावा शामिल है।

setup.py: यह एक बहु-मंच इंस्टॉलर और फ़ाइल बनाने के लिए पायथन का उत्तर है। यदि आप कमांड लाइन इंस्टालेशन से परिचित हैं, तो &&मेक इंस्टाल का अनुवाद python setup.py build &&python setup.py install करें। तो इसका उपयोग उपयोगकर्ता मशीन पर आपके प्रोजेक्ट को बनाने के लिए किया जाता है।

requirements.txt: एक पिप आवश्यकताओं फ़ाइल को परियोजना में योगदान करने के लिए आवश्यक निर्भरताओं को निर्दिष्ट करना चाहिए:परीक्षण, निर्माण, और दस्तावेज तैयार करना। यदि आपके प्रोजेक्ट में कोई विकास निर्भरता नहीं है, या आप setup.py के माध्यम से विकास पर्यावरण सेटअप पसंद करते हैं, तो यह फ़ाइल अनावश्यक है।

दस्तावेज़/: इस निर्देशिका में आपके प्रोजेक्ट के लिए दस्तावेज़ शामिल हैं।

परीक्षण/: आपके सभी परीक्षण इस निर्देशिका में रहने चाहिए। प्रारंभ में आपके पास एक एकल परीक्षण फ़ाइल होगी। जैसे-जैसे वे बढ़ने लगते हैं, आप अपने परीक्षणों को अपनी मॉड्यूल निर्देशिका की तरह बना सकते हैं।

नमूना/: इस निर्देशिका में आपका वास्तविक मॉड्यूल कोड है। यदि आपके मॉड्यूल में केवल एक फ़ाइल है, तो आप इसे सीधे अपने भंडार के मूल में sample.py के रूप में रख सकते हैं। आपकी लाइब्रेरी अस्पष्ट स्रोत या पायथन उपनिर्देशिका में नहीं है। यदि आप चाहते हैं कि यह मॉड्यूल किसी पैकेज में रहे तो इसमें एक __init__.py फ़ाइल होगी।