Ini membantu untuk menginstal paket python foopada mesin Anda (bisa juga di virtualenv) sehingga Anda dapat mengimpor paket foodari proyek lain dan juga dari [I] Python meminta.
Ia melakukan pekerjaan serupa pip, easy_installdll.,
Menggunakan setup.py
Mari kita mulai dengan beberapa definisi:
Paket - Folder / direktori yang berisi __init__.pyfile.
Module - File python yang valid dengan .pyekstensi.
Distribusi - Bagaimana satu paket berhubungan dengan paket dan modul lainnya .
Katakanlah Anda ingin menginstal paket bernama foo. Lalu kamu lakukan,
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
Sebagai gantinya, jika Anda tidak ingin menginstalnya tetapi masih ingin menggunakannya. Lalu lakukan,
$ python setup.py develop
Perintah ini akan membuat symlink ke direktori sumber di dalam paket situs alih-alih menyalin sesuatu. Karena itu, ini sangat cepat (terutama untuk paket besar).
Menciptakan setup.py
Jika Anda memiliki pohon paket seperti,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
Kemudian, Anda melakukan hal berikut dalam setup.pyskrip Anda sehingga dapat diinstal pada beberapa mesin:
from setuptools import setup
setup(
name='foo',
version='1.0',
description='A useful module',
author='Man Foo',
author_email='foomail@foo.com',
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
)
Sebaliknya, jika pohon paket Anda lebih kompleks seperti di bawah ini:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
Maka, Anda setup.pydalam hal ini akan seperti:
from setuptools import setup
setup(
name='foo',
version='1.0',
description='A useful module',
author='Man Foo',
author_email='foomail@foo.com',
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
scripts=[
'scripts/cool',
'scripts/skype',
]
)
Tambahkan lebih banyak barang ke ( setup.py) & buat layak:
from setuptools import setup
with open("README", 'r') as f:
long_description = f.read()
setup(
name='foo',
version='1.0',
description='A useful module',
license="MIT",
long_description=long_description,
author='Man Foo',
author_email='foomail@foo.com',
url="http://www.foopackage.com/",
packages=['foo'], #same as name
install_requires=['bar', 'greek'], #external packages as dependencies
scripts=[
'scripts/cool',
'scripts/skype',
]
)
Ini long_descriptiondigunakan di pypi.org sebagai deskripsi README dari paket Anda.
Dan akhirnya, Anda sekarang siap untuk mengunggah paket Anda ke PyPi.org sehingga orang lain dapat menginstal paket Anda menggunakan pip install yourpackage.
Langkah pertama adalah mengklaim nama paket Anda & ruang di pypi menggunakan:
$ python setup.py register
Setelah nama paket Anda terdaftar, tidak ada yang bisa mengklaim atau menggunakannya. Setelah pendaftaran berhasil, Anda harus mengunggah paket Anda ke sana (ke cloud) dengan,
$ python setup.py upload
Secara opsional, Anda juga dapat menandatangani paket Anda dengan GPG,
$ python setup.py --sign upload
Bonus : Lihat contoh setup.pydari proyek nyata di sini:torchvision-setup.py