كيفية إنشاء حزمة بايثون ونشرها

يتيح لك إنشاء حزمة Python ونشرها مشاركة الكود الخاص بك مع مجتمع Python الأوسع. في هذا الدليل، سنستعرض الخطوات اللازمة لإنشاء حزمة Python ونشرها على Python Package Index (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: يقوم بتمييز الدليل كحزمة Python.
• your_package/module1.py و your_package/module2.py: وحدات الحزمة الخاصة بك.
• tests/: دليل لحالات اختبار الحزمة الخاصة بك.
• setup.py: البرنامج النصي للبناء لحزمتك.
• README.md: ملف يشرح ما تفعله الحزمة الخاصة بك.
• LICENSE: ملف ترخيص الحزمة الخاصة بك.

كتابة نص الإعداد

يعد ملف 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='[email protected]',
    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

استخدم twine لتحميل الحزمة الخاصة بك إلى PyPI:

twine upload dist/*

سيُطلب منك إدخال اسم المستخدم وكلمة المرور الخاصين بحساب PyPI. بعد التحميل الناجح، ستكون الحزمة الخاصة بك متاحة على PyPI.

خاتمة

تهانينا! لقد قمت الآن بإنشاء حزمة Python ونشرها. يمكن للآخرين تثبيتها باستخدام pip، ويمكنك الاستمرار في تحديثها وتحسينها. ضع في اعتبارك الحفاظ على الحزمة الخاصة بك عن طريق تحديث رقم الإصدار وتحميل إصدارات جديدة أثناء إجراء التغييرات.