כיצד ליצור חבילת Python ולפרסם אותה

יצירה ופרסום של חבילת Python מאפשרת לך לשתף את הקוד שלך עם קהילת Python הרחבה יותר. במדריך זה, נעבור על השלבים ליצירת חבילת Python ונפרסם אותה באינדקס Python Package (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='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

השתמש ב-twine כדי להעלות את החבילה שלך ל- PyPI:

twine upload dist/*

תתבקש להזין את שם המשתמש והסיסמה שלך PyPI. לאחר העלאה מוצלחת, החבילה שלך תהיה זמינה ב- PyPI.

מַסְקָנָה

מזל טוב! כעת יצרת ופרסמת את חבילת Python שלך. אחרים יכולים להתקין אותו באמצעות pip, ואתה יכול להמשיך לעדכן ולשפר אותו. זכור לשמור על החבילה שלך על ידי עדכון מספר הגרסה והעלאת מהדורות חדשות תוך כדי ביצוע שינויים.