Cara Membuat Paket Python dan Mempublikasikannya
Membuat dan menerbitkan paket Python memungkinkan Anda untuk berbagi kode dengan komunitas Python yang lebih luas. Dalam panduan ini, kami akan memandu Anda melalui langkah-langkah untuk membuat paket Python dan menerbitkannya ke Python Package Index (PyPI), tempat orang lain dapat dengan mudah memasang dan menggunakannya.
Menyiapkan Proyek Anda
Sebelum memulai, pastikan Anda telah menginstal Python di sistem Anda. Anda juga perlu menginstal paket setuptools
dan wheel
jika Anda belum melakukannya:
pip install setuptools wheel
Membuat Struktur Paket
Buat direktori baru untuk proyek paket Anda. Di dalam direktori ini, buat struktur berikut:
your_package/
your_package/
__init__.py
module1.py
module2.py
tests/
__init__.py
test_module1.py
setup.py
README.md
LICENSE
Berikut ikhtisar singkat dari berkas-berkas tersebut:
your_package/__init__.py
: Menandai direktori sebagai paket Python.your_package/module1.py
danyour_package/module2.py
: Modul paket Anda.tests/
: Direktori untuk kasus pengujian paket Anda.setup.py
: Skrip build untuk paket Anda.README.md
: Berkas yang menjelaskan apa yang dilakukan paket Anda.LICENSE
: Berkas lisensi paket Anda.
Menulis Skrip Pengaturan
File setup.py
sangat penting untuk menentukan metadata dan dependensi paket Anda. Berikut contoh dasarnya:
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',
)
Membuat File README
Berkas README.md
akan memberikan gambaran umum tentang paket Anda, termasuk cara menginstal dan menggunakannya. Berikut ini contohnya:
# Your Package
A brief description of your package.
Instalasi
pip install your_package
Penggunaan
import your_package
# Example usage
Membangun Paket
Navigasi ke direktori proyek Anda dan jalankan perintah berikut untuk membangun paket Anda:
python setup.py sdist bdist_wheel
Perintah ini membuat arsip distribusi di direktori dist/
.
Menerbitkan ke PyPI
Untuk menerbitkan paket Anda, Anda memerlukan akun di PyPI. Jika Anda belum memilikinya, buatlah di PyPI.
Berikutnya, instal paket twine
:
pip install twine
Gunakan twine
untuk mengunggah paket Anda ke PyPI:
twine upload dist/*
Anda akan diminta memasukkan nama pengguna dan kata sandi PyPI. Setelah pengunggahan berhasil, paket Anda akan tersedia di PyPI.
Kesimpulan
Selamat! Anda kini telah membuat dan menerbitkan paket Python Anda. Orang lain dapat menginstalnya menggunakan pip
, dan Anda dapat terus memperbarui dan menyempurnakannya. Ingatlah untuk memelihara paket Anda dengan memperbarui nomor versi dan mengunggah rilis baru saat Anda membuat perubahan.