यह fooआपकी मशीन पर अजगर पैकेज स्थापित करने में मदद करता है (इसमें भी हो सकता है virtualenv) ताकि आप पैकेज fooको अन्य परियोजनाओं से आयात कर सकें और [I] पायथन प्रॉम्प्ट से भी।
यह इसी तरह का काम करता है pip, easy_installआदि।
का उपयोग करते हुए setup.py
आइए कुछ परिभाषाओं के साथ शुरू करें:
पैकेज - एक फ़ोल्डर / निर्देशिका जिसमें __init__.pyफ़ाइल शामिल है।
मॉड्यूल - .pyविस्तार के साथ एक मान्य अजगर फ़ाइल ।
वितरण - एक पैकेज अन्य पैकेज और मॉड्यूल से कैसे संबंधित है ।
मान लें कि आप एक पैकेज स्थापित करना चाहते हैं जिसका नाम है foo। फिर आप करते हैं,
$ git clone https://github.com/user/foo
$ cd foo
$ python setup.py install
इसके बजाय, यदि आप वास्तव में इसे स्थापित नहीं करना चाहते हैं, लेकिन फिर भी इसका उपयोग करना चाहते हैं। फिर करो,
$ python setup.py develop
यह कमांड चीजों को कॉपी करने के बजाय साइट-पैकेज के भीतर स्रोत निर्देशिका के लिए सहानुभूति पैदा करेगा। इस वजह से, यह काफी तेज है (विशेषकर बड़े पैकेजों के लिए)।
बनाना setup.py
यदि आपके पास अपना पैकेज ट्री है जैसे,
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
└── setup.py
फिर, आप अपनी setup.pyस्क्रिप्ट में निम्नलिखित करते हैं ताकि इसे किसी मशीन पर स्थापित किया जा सके:
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
)
इसके बजाय, यदि आपका पैकेज ट्री नीचे वाले की तरह अधिक जटिल है:
foo
├── foo
│ ├── data_struct.py
│ ├── __init__.py
│ └── internals.py
├── README
├── requirements.txt
├── scripts
│ ├── cool
│ └── skype
└── setup.py
फिर, आपका setup.pyइस मामले में ऐसा होगा:
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',
]
)
अधिक सामान जोड़ें ( setup.py) और इसे सभ्य बनाएं:
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',
]
)
यह आपके पैकेज के README विवरण के रूप long_descriptionमें pypi.org में उपयोग किया जाता है ।
और अंत में, अब आप अपने पैकेज को PyPi.org पर अपलोड करने के लिए तैयार हैं ताकि अन्य आपके पैकेज का उपयोग करके इंस्टॉल कर सकें pip install yourpackage।
पहला कदम अपने पैकेज के नाम और स्पेस का उपयोग करके पीपीआई में दावा करना है:
$ python setup.py register
एक बार आपके पैकेज का नाम पंजीकृत हो जाने के बाद, कोई भी इसका दावा या उपयोग नहीं कर सकता है। सफल पंजीकरण के बाद, आपको अपना पैकेज वहां (क्लाउड पर) अपलोड करना होगा,
$ python setup.py upload
वैकल्पिक रूप से, आप अपने पैकेज के साथ GPG,
$ python setup.py --sign upload
बोनस : setup.pyयहां एक वास्तविक परियोजना से एक नमूना देखें :torchvision-setup.py