tl.pkg

tl.pkg স্পিংক্স ডক্স সঙ্গে একটি namespaced পাইথন প্যাকেজের জন্য একটি টেমপ্লেট.
এই প্যাকেজ স্পিংক্স ডকুমেন্টেশন এবং একটি উন্নয়ন buildout সঙ্গে পাইথন প্যাকেজ মৌলিক ফাইল ও ডিরেক্টরি বিন্যাস তৈরি করে. এটি দুটি অংশ নিয়ে গঠিত:
- একটি paste.script নামস্থান এক স্তর যে জীবন একটি পাইথন প্যাকেজের জন্য boilerplate, সৃষ্টি টেমপ্লেট, এবং
- প্রয়োজনীয় প্যাকেজ নির্ভরতা এবং কিছু theming সঙ্গে বরাবর, স্পিংক্স কনফিগার করা হয় যে একটি পাইথন মডিউল.
প্যাকেজ পাইথন 2.6 এবং 2.7 সঙ্গে কাজ করে.
ব্যবহারের
Paster তা খুঁজে পেতে পারেন যেখানে tl.pkg ইনস্টল করুন, Paster টেমপ্লেট প্রাপ্তিসাধ্য না করতে. তারপর Paster করুন:
& Nbsp;. Paster --template TL-pkg <নামস্থান> তৈরি
এই zc.buildout কনফিগারেশন, স্পিংক্স প্যাকেজ ডকুমেন্টেশন কঙ্কাল, এবং ইনিশিয়ালাইজ একটি তত্পর সংগ্রহস্থলের সাথে সম্পূর্ণ একটি ডিম বিতরণের জন্য boilerplate,, উৎপন্ন হবে. এটা বিন / পরীক্ষা একটি testrunner এবং বিন / ডক একটি ডকুমেন্টেশন রচয়িতা ইনস্টল করা হবে, যাতে buildout কনফিগারেশন, উন্নয়ন লক্ষ্য করা হয়.
কয়েক ভেরিয়েবল, তাদের মধ্যে একটি এক লাইন বিবরণ ও প্যাকেজের কিছু কীওয়ার্ড অনুরোধ জানানো হবে.
Personalisation,
Paster জন্য অনুরোধ জানানো হবে যে আরও তিনটি ভেরিয়েবল এটা উত্পন্ন করবে প্যাকেজ কঙ্কাল ব্যক্তিগতকৃত করতে ব্যবহার করা হয়. এই ভেরিয়েবল যদি উপস্থিত থাকে একটি ফাইল নামে $ হোম / .tl-pkg.cfg থেকে পড়া হয় যে ডিফল্ট মান থাকতে পারে. ফাইল পাইথন এর ConfigParser দ্বারা বোঝা এবং (এ পর্যন্ত একটি অবাধ নাম) এক অধ্যায় ধারণ হিসাবে নিম্নলিখিত ভেরিয়েবল যে কোন সংজ্ঞায়িত করে স্টার ফাইল বাক্য গঠন অনুসরণ করা প্রয়োজন:
লেখক: আপনার পুরো নাম. এই প্যাকেজের মিটা-ডাটা ও ডকুমেন্টেশন হিসাবে ভাল হিসাবে উত্পন্ন কোনো পাইথন ফাইলের কপিরাইট নোটিশ প্রদর্শিত হবে.
লেখক-ইমেইল: আপনার ই-মেইল ঠিকানা. এই প্যাকেজ মেটাডেটা এবং ডকুমেন্টেশন উভয় প্রদর্শিত হবে.
bitbucket নাম: আপনার bitbucket ব্যবহারকারী নাম. এই প্রকল্পের অন্তর্গত বিভিন্ন URL গুলি গঠনে ব্যবহৃত হয়. বর্তমানে, ভাবনাটি হলো এই প্রকল্পের এ হোস্ট করা হয় এবং প্যাকেজের মিটা-ডাটা ও ডকুমেন্টেশন বিন্দু কোনো URL গুলি যে bitbucket প্রকল্পের পেজ যথাযথ হয়.
প্যাকেজ বিষয়বস্তু
এই যখন সম্পাদনা করতে ফাইল যা পরামর্শ বরাবর, তৈরি ফাইল এবং ডিরেক্টরি উদ্দেশ্য ব্যাখ্যা করা হয়. অনেক ফাইল এ সব পরিবর্তন করা প্রয়োজন হবে না.
পাইথন বিতরণ
setup.py: প্যাকেজ সংজ্ঞা এবং মেটাডেটা. প্যাকেজের সংস্করণ সংখ্যা, নির্ভরতা, এন্ট্রি পয়েন্ট পরিবর্তন অন্তত যখনই এই ফাইল আপডেট করুন.
<নামস্থান>: প্যাকেজের সোর্স কোড গাছ. একই নামস্থান অন্যান্য প্যাকেজ আমদানি করা যাবে না পাছে নামস্থান প্যাকেজ এর __init__.py ফাইল পরিবর্তন করবেন না.
প্রাণবান সংগ্রহস্থলের
.hg: প্যাকেজ তৈরি করা হয়েছে যখন তত্পর সংগ্রহস্থলের ইতিমধ্যে ইনিশিয়ালাইজ করা হয়. তৈরি ফাইল এখনো প্রতিশ্রুতিবদ্ধ করা হয় নি.
.hg / hgrc: সংগ্রহস্থল কনফিগারেশন, যদি থাকে, কিছু তত্পর হোস্টিং প্যাকেজ ভবিষ্যত URL- এ যে পয়েন্ট. এটি আপনার HG ব্যবহারকারী নাম নির্ধারণ করা হবে.
.hgignore: ফাইল এবং ডিরেক্টরি তত্পর উপেক্ষা করা হবে. এই buildout, ডকুমেন্টেশন তৈরী করে বা প্যাকেজ রিলিজ দ্বারা উত্পন্ন করা হবে বলে আশা স্থানীয় কনফিগারেশন এবং উপাদান রয়েছে. এটা (* .egg-তথ্য), বিতরণ, বা এই প্রকল্পের নির্দিষ্ট না, যা আপনার এডিটর মত অন্যান্য সাধারণ সরঞ্জাম, (যেমন .pyc * হিসাবে) পাইথন দ্বারা উত্পন্ন ফাইল অন্তর্ভুক্ত নয়. আপনার ডিফল্ট তত্পর অগ্রাহ্য তালিকা যেমন নিদর্শন হতে হবে.
উন্নয়ন buildout
bootstrap.py: বিন / buildout স্ক্রিপ্ট তৈরি করে. Buildout ব্যবহার করা উচিত যে একই পাইথন ইন্টারপ্রেটার সঙ্গে এই চালান. কোন প্রয়োজন নেই কখনও এই ফাইলটি সম্পাদনা করতে.
buildout.cfg: একটি পরীক্ষা রানার এবং প্যাকেজের জন্য একটি ডকুমেন্টেশন রচয়িতা তৈরি করে যে একটি কাজ buildout কনফিগারেশন. প্যাকেজ নিজেই একটি বিকাশ ডিম হিসাবে অন্তর্ভুক্ত করা হয় এবং buildout অন্য কোন প্যাকেজ শুধুমাত্র পিনযুক্ত সংস্করণ ব্যবহার করার জন্য কনফিগার করা হয়. প্যাকেজ এর অফিসিয়াল উন্নয়ন buildout কনফিগার কিন্তু local.cfg স্থানীয় customisations করা এই সম্পাদনা করুন. সংস্করণ pinnings versions.cfg এই ফাইল এর সংস্করণ বিভাগে ঘোষণা এই একই ফাইল এর buildout অধ্যায় দ্বারা ডিম বিকশিত হয় যে প্যাকেজ pinnings পূর্বাবস্থা উচিত / যখন সংস্করণ যান.
local.cfg: অন্যান্য ডেভেলপারদের কোন আগ্রহ নেই যে buildout কনফিগারেশন স্থানীয় customisations. এই তত্পর দ্বারা উপেক্ষিত হচ্ছে. তারপর থেকে আপনি এই ফাইলটি পরিবর্তন করা হলে, রান বিন / buildout -c local.cfg. এই buildout.cfg মধ্যে এবং সংস্করণ নিয়ন্ত্রণে অ স্থানীয় কনফিগারেশন পালন, প্রথমে কষ্টকর শব্দ হতে পারে, যেমন একটি অবিচ্ছিন্ন ইন্টিগ্রেশন সার্ভারে প্যাকেজ পরীক্ষা হিসাবে ব্যবহারের ক্ষেত্রে গুরুত্বপূর্ণ.
সংস্করণ / versions.cfg:
& Nbsp; সংস্করণ Zope টুলকিট অংশ নয় যে buildout দ্বারা ব্যবহৃত কোনো প্যাকেজ পিন. ডকুমেন্টেশন নির্মাণের জন্য প্রয়োজন বোধ করা হয় যা tl.pkg সংস্করণ প্যাকেজ ফাইল তৈরি একই সংস্করণ যে পিনযুক্ত করা হয়. পরে tl.pkg আপগ্রেড করার সময়, চাহিদা পিন এই সংস্করণে সংস্করণের মধ্যে প্যাকেজ টেমপ্লেট পরিবর্তন হয়েছে যে কোন ফাইল সহ আপডেট করা হবে. আপনার প্যাকেজ অথবা আপনার buildout প্রয়োজনীয় যে কোন ডিম সংস্করণ পিন এই ফাইলটি সম্পাদনা করুন.
সংস্করণ / ztk-সংস্করণ-X.Y.Z.cfg:
& Nbsp; Zope টুলকিট একটি নির্দিষ্ট রিলিজ, আমাদের সংস্করণ pinnings অন্তর্ভুক্ত করা হয়েছে. এই একটি স্থানীয় অনুলিপি রাখা নেটওয়ার্ক অ্যাক্সেস ছাড়া buildout নির্মাণ করতে পারবেন. এই ফাইলটি সম্পাদনা করবেন না.
সাধারণ প্যাকেজ ডকুমেন্টেশন
ডকুমেন্টেশন মান টুকরা ধারণ করে এবং এর ফলে যে জায়গায় এবং তাদের নির্দিষ্ট নাম অধীনে আশা করা যায়, এবং যা স্পিংক্স প্রবেশযোগ্য স্বাধীন হতে হবে যে প্যাকেজ এর শীর্ষ স্তরের ডিরেক্টরির মধ্যে পাওয়া যাবে টেক্সট ফাইল একটি নম্বর আছে. এই ফাইল আক্ষরিকভাবে অন্তর্ভুক্ত করা হয়, যা কপিরাইট নোটিশ এবং লাইসেন্স টেক্সট ছাড়া, পুরো ডকুমেন্টেশন নির্মাণের সময় তারা স্পিংক্স দ্বারা প্রক্রিয়াভুক্ত করা হচ্ছে হিসাবে বৈধ পুনর্গঠন টেক্সট হতে হবে.
README.txt: তার PyPI পৃষ্ঠার ও ডকুমেন্টেশন এর সূচক পাতা অংশ হতে হবে, যা প্যাকেজ এর উদ্দেশ্য, বিষয়বস্তু এবং ব্যবহার একটি ওভারভিউ. এই আপ টু ডেট সব সময়ে প্যাকেজের বিষয়বস্তু সঙ্গে রাখতে হবে.
CHANGES.txt: প্যাকেজ ব্যবহারকারীদের জন্য প্রাসঙ্গিক প্যাকেজ কোন পরিবর্তন সঙ্গে আপডেট করা প্রয়োজন যে পরিবর্তনের লগ. ফাইলের বিন্যাস zest.releaser এবং (পাবলিক তত্পর সংগ্রহস্থলের মধ্যে "টিপ" সংস্করণ বড়) এর বর্তমান সংস্করণ PyPI পাতা এবং নির্মিত প্যাকেজ ডকুমেন্টেশন থেকে নির্দিষ্ট করা হবে দ্বারা বোঝা যায়.
ABOUT.txt: প্যাকেজ এবং যেমন আধুনিক ই-মেইল ঠিকানা হিসাবে তার লেখক, এবং প্যাকেজ এর ডকুমেন্টেশন URL, PyPI পাতা, বিষয় অনুসরণ এবং সোর্স কোড হিসেবে বর্তমান লগ সম্পর্কে কিছু পয়েন্টার. এটা যে ডকুমেন্টেশন PyPI এবং উভয় প্রকাশ করা হবে অধিকৃত হয়; আপনি আপনার প্রকল্পের নির্ধারিত সঠিক নিজ নিজ URL গুলি ব্যবহার নিশ্চিত করা উচিত.
COPYRIGHT.txt: কপিরাইট বছর এবং Zope পাবলিক লাইসেন্স, ডিফল্টরূপে সংস্করণ 2.1, যা ব্যবহার করা লাইসেন্স, সম্পর্কে কিছু পরামর্শ কপিরাইট ধারক: প্যাকেজ জন্য কপিরাইট তথ্য. অন্তত বছর আপডেট করতে এই সম্পাদনা করুন.
LICENSE.txt: ব্যবহৃত লাইসেন্স সরকারী লেখার একটি কপি. এই একটি ভিন্ন লাইসেন্সের জন্য এটি বিনিময় ছাড়া সম্পাদনা করবেন না.
সম্পূর্ণ ডকুমেন্টেশন, স্পিংক্স ব্যবহার করে নির্মিত
ডক: স্পিংক্স তৈরি ডকুমেন্টেশন শুধুমাত্র প্রাসঙ্গিক যে সবকিছু. আমরা স্পিংক্স ইনপুট ফাইল জন্য প্রত্যয় .txt ব্যবহার করুন. নিয়মাবলী একটি সংখ্যা ডক ডিরেক্টরির বিষয়বস্তু জন্য বিদ্যমান, কিছুই খারাপ অবাধে আপনি এটি পরিবর্তন করে প্যাকেজ বাকি ঘটতে হবে; শুধু এটা বৈধ স্পিংক্স ইনপুট অবশেষ নিশ্চিত করুন.
ডক / conf.py: স্পিংক্স কনফিগারেশন. মূলত কনফিগারেশন মান সব নিয়মাবলী অনুসরণ এবং সেইজন্য tl.pkg থেকে আমদানি করা হয়, তাই আপনি tl.pkg.sphinxconf অক্ষত আমদানি ও আবাহন রাখতে হবে. আপনি মেটাডাটা বা শুধু এই প্যাকেজের জন্য ডকুমেন্টেশন চেহারা সম্পর্কে কিছু পরিবর্তন করতে চান তাহলে আপনি এই ফাইলটি সম্পাদনা করতে হবে. স্পিংক্স তৈরি ডকুমেন্টেশন জন্য নিয়মাবলী আপডেট tl.pkg আপগ্রেড দ্বারা অর্জিত হবে.
ডক / index.txt: নথিপত্র সামনে পাতা. এটা উপরের স্তরের README.txt ফাইল এবং সম্পূর্ণ ডকুমেন্টেশন বিভাগে প্রতি নির্দেশ বিষয়বস্তু একটি টেবিল থেকে প্যাকেজ সংক্ষিপ্ত বিবরণ অন্তর্ভুক্ত করা হয়েছে. এই উত্পন্ন এপিআই ডকুমেন্টেশন, প্যাকেজ এবং পরিবর্তনের লগ সম্পর্কে কিছু মেটা তথ্য অন্তর্ভুক্ত. উদাহরণস্বরূপ, উপরের স্তরের বিভাগে যোগ করতে চান তাহলে এই ফাইল সম্পাদনা করুন.
ডক / narrative.txt:
& Nbsp; আখ্যান প্যাকেজ ডকুমেন্টেশন মূল নথি. এটি আপনার উৎস গাছ পাইথন মডিউল মধ্যে রক্ষিত যে কোন নথি পরীক্ষা ফাইল সংগ্রহ করা হয়. আপনি তাদের নথি নাম প্যাটার্ন হচ্ছে, toctree নির্দেশনা অনুযায়ী ফাইল তালিকা প্রয়োজন <নামস্থান> -. (.txt প্রত্যয় ছাড়া). একটি মন্তব্য-আউট উদাহরণস্বরূপ ফাইল তালিকা অন্তর্ভুক্ত করা হয়.
ডক / api.txt: তৈরি এপিআই ডকুমেন্টেশন মূল নথি. API- টি আধা-স্বয়ংক্রিয়ভাবে আপনার autosummary নির্দেশনা অনুযায়ী, সমস্ত মডিউল থেকে তারপর স্বয়ংক্রিয়ভাবে, যা নথিভুক্ত করা হবে, এই ফাইলের তালিকা আছে নথিভুক্ত করা হয়. একটি মন্তব্য-আউট উদাহরণ মডিউল তালিকা অন্তর্ভুক্ত করা হয়.
ডক / overview.txt:
& Nbsp; একটি শহরের উপর অসম্পূর্ণ নিবন্ধ উপরের স্তরের ফাইল README.txt অন্তর্ভুক্ত. কোন প্রয়োজন এই ফাইলটি সম্পাদনা করতে.
about.txt ডক /: প্যাকেজ সম্পর্কে মেটা তথ্য, উপরের স্তরের ফাইল ABOUT.txt, COPYRIGHT.txt, এবং LICENSE.txt মিশ্রন. আপনি এই ফাইলটি সম্পাদনা করতে প্রয়োজন হবে না.
ডক / changes.txt:
& Nbsp; একটি শহরের উপর অসম্পূর্ণ নিবন্ধ উপরের স্তরের ফাইল CHANGES.txt অন্তর্ভুক্ত. কোন প্রয়োজন এই ফাইলটি সম্পাদনা করতে.
ডক / requirements.pip:
& Nbsp; ডকুমেন্টেশন নির্মাণ করা প্রয়োজন (স্পিংক্স নিজেই ছাড়া) পাইথন ডিম তালিকা. এই ডকুমেন্টেশন নির্মাণের জন্য বোঝানো হয়. আপনি tl.pkg দ্বারা বাস্তবায়িত নিয়মাবলী ব্যবহার করতে পারবেন, যাতে তাদের সাথে সাদা তালিকাভুক্ত করা হবে. আপনার ডকুমেন্টেশন প্যাকেজ নির্ভরতা পরিবর্তন যখনই এই ফাইলটি সম্পাদনা করুন; আপনি এখানে ডিম অতিরিক্ত ব্যবহার করতে পারবেন না.
পুরো ডকুমেন্টেশন নির্মাণের
উত্পন্ন buildout কনফিগারেশন ডকুমেন্টেশন নির্মাণ স্পিংক্স যে আহ্বান বিন / ডক একটি স্ক্রিপ্ট ইনস্টল করা হবে. এই স্ক্রিপ্ট চালানোর জন্য, আপনার বর্তমান কাজ ডিরেক্টরির প্যাকেজ রুট হতে হবে. স্ক্রিপ্ট (প্যাকেজ এর শীর্ষ স্তরের ডিরেক্টরির আপেক্ষিক) নির্মাণ / ডক / পাতাটা ডকুমেন্টেশন করা হবে. বিন / নথি প্রেরণ করা বিকল্প অন্তর্নিহিত স্পিংক্স বিল্ড কমান্ড পাস করা, কিন্তু অবস্থানগত আর্গুমেন্ট কাজ করবে না দয়া করে নোট করা হবে.
স্পিংক্স কনফিগারেশন মান
আপনি কোর স্পিংক্স ভেরিয়েবল পাশাপাশি এই কনফিগার করতে পারেন তাই ডিফল্টরূপে, স্পিংক্স এক্সটেনশনের একটি সংখ্যা, সক্রিয় করা হয়:
- Sphinx.ext.autosummary
- Sphinx.ext.viewcode
- Sphinx.ext.inheritance_diagram
- Sphinxcontrib.cheeseshop
- Sphinxcontrib.issuetracker
আপনি কেবল আপনার conf.py. মধ্যে নিজ নিজ ভেরিয়েবল সেট করে tl.pkg থেকে ডিফল্ট মান অগ্রাহ্য করা যাবে tl.pkg.sphinxconf.set_defaults আবাহন শেষে কি করা প্রয়োজন:
source_suffix = '.foo'
আমদানি tl.pkg.sphinxconf
tl.pkg.sphinxconf.set_defaults ()
বিপরীতভাবে, sphinxconf মান নির্ণয় করতে conf.py থেকে ভেরিয়েবল ব্যবহার করার চেষ্টা করে. এই ভেরিয়েবল উল্লেখ না করা হলে set_defaults বলা হয়, আগে যে কাজ করতে হবে. বর্তমানে, নিম্নলিখিত ভেরিয়েবল স্বীকৃত হয়:
_year_started: প্রকল্প শুরু হয়েছিল বছরের জন্য ঐচ্ছিক মান. এটা নির্দিষ্ট করা এবং বর্তমান বছরের থেকে ভিন্ন হলে (ডকুমেন্টেশন ভবন সময়) বর্তমান বছরের এই ডিফল্টরূপে, কিন্তু, এটি "2001-2012 লেখক" মত একটি কপিরাইট নোটিশ গঠনে ব্যবহৃত হয়.
_flattr_url: নির্দিষ্ট হলে, এই পুরো ডকুমেন্টেশন মেনু কলামের উপরের অংশে প্রদর্শিত হবে এই প্রকল্প এবং Flattr দান বোতাম জন্য একটি Flattr জিনিস URL টি গণ্য করা হয়. PyPI পৃষ্ঠায় একটি Flattr বাটন যোগ করার জন্য, ABOUT.txt মধ্যে "প্রকল্প সহায়তা" আইটেম uncomment এবং সেখানে হিসাবে ভাল URL টি পূরণ করুন.
_issuetracker_offline:
& Nbsp; একটি সত্য মান সেট করেন তাহলে ডকুমেন্টেশন এবং স্পিংক্স রান নির্মাণের সময় এটা সার্ভার অ্যাক্সেস করার চেষ্টা করবে না, যাতে sphinxcontrib-issuetracker ইন্টিগ্রেশন bitbucket ইন্টিগ্রেশন পরিবর্তন করা হবে নেটওয়ার্কের প্রবেশাধিকার স্বাধীন রয়ে যায়. (অন্যান্য trackers সঙ্গে ইন্টিগ্রেশন পর্যন্ত যত্ন গ্রহণ করা হয়েছে.) এই যেমন, যে ব্যক্তি অনুসরণ করে ইন্টিগ্রেশন কিছু বৈশিষ্ট্য নিষ্ক্রিয় কিন্তু ধরে রাখতে হবে, প্লেইন-টেক্সট ইস্যু সংখ্যা চিনতে issuetracker এক্সটেনশন এর ক্ষমতা.
অবশেষে, tl.pkg.sphinxconf মডিউল ডকুমেন্টেশন যেমন একটি সিস্টেমের উপর নির্মিত হবে যদি আপনি উপহাস মডিউল রেজিস্টার কল করতে পারেন যে একটি ফাংশন নির্ধারণ মডিউল মত (নির্দিষ্ট কোড ইনস্টল করা যাবে না যে ) সি প্রয়োগ:
tl.pkg.sphinxconf.register_mock_modules ('কায়রো', 'এর Gobject', 'GTK')

আবশ্যক

• পাইথন