Python Paketi Nasıl Oluşturulur ve Yayınlanır
Bir Python paketi oluşturmak ve yayınlamak, kodunuzu daha geniş Python topluluğuyla paylaşmanıza olanak tanır. Bu kılavuzda, bir Python paketi oluşturma ve bunu başkalarının kolayca kurabileceği ve kullanabileceği Python Paket Dizini'nde (PyPI) yayınlama adımlarını ele alacağız.
Projenizi Kurma
Başlamadan önce, sisteminizde Python'un yüklü olduğundan emin olun. Ayrıca, henüz yüklemediyseniz setuptools
ve wheel
paketlerini de yüklemeniz gerekecektir:
pip install setuptools wheel
Paket Yapısının Oluşturulması
Paket projeniz için yeni bir dizin oluşturun. Bu dizinin içinde aşağıdaki yapıyı oluşturun:
your_package/
your_package/
__init__.py
module1.py
module2.py
tests/
__init__.py
test_module1.py
setup.py
README.md
LICENSE
İşte bu dosyaların kısa bir özeti:
your_package/__init__.py
: Dizini Python paketi olarak işaretler.your_package/module1.py
veyour_package/module2.py
: Paket modülleriniz.tests/
: Paketinizin test vakalarının dizini.setup.py
: Paketinizin derleme betiği.README.md
: Paketinizin ne işe yaradığını açıklayan bir dosya.LİSANS
: Paketinizin lisans dosyası.
Kurulum Komut Dosyasını Yazma
setup.py
dosyası paketinizin meta verilerini ve bağımlılıklarını tanımlamak için önemlidir. İşte basit bir örnek:
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 Dosyası Oluşturma
README.md
dosyası paketinizin nasıl kurulacağı ve kullanılacağı da dahil olmak üzere paketinizin genel bir görünümünü sağlamalıdır. İşte bir örnek:
# Your Package
A brief description of your package.
Kurulum
pip install your_package
Kullanım
import your_package
# Example usage
Paketin Oluşturulması
Proje dizininize gidin ve paketinizi derlemek için aşağıdaki komutu çalıştırın:
python setup.py sdist bdist_wheel
Bu komut dist/
dizininde dağıtım arşivleri oluşturur.
PyPI'ye Yayımlama
Paketinizi yayınlamak için PyPI'da bir hesaba ihtiyacınız var. Eğer yoksa, PyPI adresinde oluşturun.
Daha sonra twine
paketini kurun:
pip install twine
Paketinizi PyPI'ye yüklemek için twine
kodunu kullanın:
twine upload dist/*
PyPI kullanıcı adınız ve şifreniz istenecektir. Başarılı bir yüklemeden sonra paketiniz PyPI'da kullanılabilir olacaktır.
Çözüm
Tebrikler! Artık Python paketinizi oluşturdunuz ve yayınladınız. Diğerleri pip
kullanarak yükleyebilir ve siz de güncellemeye ve geliştirmeye devam edebilirsiniz. Değişiklikler yaptıkça sürüm numarasını güncelleyerek ve yeni sürümleri yükleyerek paketinizi korumayı unutmayın.