पायथन पैकेज कैसे बनाएं और उसे प्रकाशित करें

पायथन पैकेज बनाना और प्रकाशित करना आपको अपने कोड को व्यापक पायथन समुदाय के साथ साझा करने की अनुमति देता है। इस गाइड में, हम पायथन पैकेज बनाने और इसे पायथन पैकेज इंडेक्स (PyPI) पर प्रकाशित करने के चरणों के माध्यम से चलेंगे, जहाँ अन्य लोग इसे आसानी से इंस्टॉल और उपयोग कर सकते हैं।

अपना प्रोजेक्ट सेट अप करना

शुरू करने से पहले, सुनिश्चित करें कि आपके सिस्टम पर Python इंस्टॉल है। अगर आपने पहले से ऐसा नहीं किया है, तो आपको setuptools और wheel पैकेज भी इंस्टॉल करने होंगे:

pip install setuptools wheel

पैकेज संरचना बनाना

अपने पैकेज प्रोजेक्ट के लिए एक नई निर्देशिका बनाएँ। इस निर्देशिका के अंदर, निम्नलिखित संरचना बनाएँ:

your_package/
    your_package/
        __init__.py
        module1.py
        module2.py
    tests/
        __init__.py
        test_module1.py
    setup.py
    README.md
    LICENSE

इन फ़ाइलों का संक्षिप्त अवलोकन यहां दिया गया है:

  • your_package/__init__.py: निर्देशिका को पायथन पैकेज के रूप में चिह्नित करता है।
  • your_package/module1.py और your_package/module2.py: आपके पैकेज मॉड्यूल.
  • tests/: आपके पैकेज के परीक्षण मामलों की निर्देशिका.
  • setup.py: आपके पैकेज के लिए बिल्ड स्क्रिप्ट.
  • README.md: एक फ़ाइल जो बताती है कि आपका पैकेज क्या करता है।
  • लाइसेंस: आपके पैकेज की लाइसेंस फ़ाइल.

सेटअप स्क्रिप्ट लिखना

setup.py फ़ाइल आपके पैकेज के मेटाडेटा और निर्भरता को परिभाषित करने के लिए आवश्यक है। यहाँ एक बुनियादी उदाहरण दिया गया है:

from setuptools import setup, find_packages

setup(
    name='your_package',
    version='0.1.0',
    packages=find_packages(),
    install_requires=[
        # List your package dependencies here
    ],
    description='A brief description of your package',
    long_description=open('README.md').read(),
    long_description_content_type='text/markdown',
    url='https://github.com/yourusername/your_package',
    author='Your Name',
    author_email='your.email@example.com',
    license='MIT',
)

README फ़ाइल बनाना

README.md फ़ाइल आपके पैकेज का अवलोकन प्रदान करेगी, जिसमें इसे स्थापित करने और उपयोग करने का तरीका भी शामिल है। यहाँ एक उदाहरण दिया गया है:

# Your Package

A brief description of your package.

इंस्टालेशन

pip install your_package

प्रयोग

import your_package

# Example usage

पैकेज का निर्माण

अपनी परियोजना निर्देशिका पर जाएँ और अपना पैकेज बनाने के लिए निम्नलिखित कमांड चलाएँ:

python setup.py sdist bdist_wheel

यह आदेश dist/ निर्देशिका में वितरण अभिलेखागार बनाता है।

PyPI पर प्रकाशन

अपना पैकेज प्रकाशित करने के लिए, आपको PyPI पर एक खाता चाहिए। यदि आपके पास खाता नहीं है, तो इसे PyPI पर बनाएँ।

इसके बाद, twine पैकेज स्थापित करें:

pip install twine

PyPI पर अपना पैकेज अपलोड करने के लिए twine का उपयोग करें:

twine upload dist/*

आपसे PyPI उपयोगकर्ता नाम और पासवर्ड मांगा जाएगा। सफल अपलोड के बाद, आपका पैकेज PyPI पर उपलब्ध हो जाएगा।

निष्कर्ष

बधाई हो! अब आपने अपना पायथन पैकेज बना लिया है और प्रकाशित कर दिया है। अन्य लोग इसे pip का उपयोग करके इंस्टॉल कर सकते हैं, और आप इसे अपडेट और सुधारना जारी रख सकते हैं। अपने पैकेज को बनाए रखने के लिए संस्करण संख्या को अपडेट करना और बदलाव करते समय नई रिलीज़ अपलोड करना याद रखें।

लिंक
Python