.
Okydoky স্পিংক্স, বিতরণ এবং GitHub (setuptools, যা ছিল) & nbsp ব্যবহার করে একটি স্বয়ংক্রিয় ডকুমেন্টেশন রচয়িতা; এটা ক্রমাগত নিম্নলিখিত অনুমানের সঙ্গে, নথি নির্মাণ করতে আপনার বন্ধ পাইথন প্রকল্প তোলে:
1. ডকুমেন্টেশন স্পিংক্স ব্যবহার করা যাবে.
2. প্রকল্প (হত্যা না কোনো অন্যদের না) setuptools মাধ্যমে করা হয়.
3. সোর্স কোড GitHub অধীনে পরিচালিত হয়.
খুব শীঘ্রই বলে, এটা শুধু ব্যক্তিগত ব্যবহারের জন্য একটি ReadTheDocs.org না.
কিভাবে কাজ করে
নিম্নলিখিত নির্দেশাবলী কাজ করে:
নতুন করে push করা হয় 1. যখন, GitHub হুক পোস্ট পাবেন Okydoky আরম্ভ করে.
2. Okydoky ডাউনলোড GitHub থেকে ধাক্কা করে আর্কাইভ tarball.
3. tarball আর্কাইভ একটি অস্থায়ী ডিরেক্টরির মধ্যে নিষ্কাশিত হয়.
4. স্পিংক্স ডকুমেন্টেশন তৈরী করে.
ব্যবহারকারীরা তাদের ওয়েব ব্রাউজার ব্যবহার করে ডক্স অনুরোধ 5. Okydoky GitHub উপভোক্তা কী ব্যবহার করে প্রমাণ করতে ব্যবহারকারী অনুরোধ জানানো হবে.
তারা অনুমোদন আছে 6 Okydoky একটি অন্তর্নির্মিত ডক্স কাজ করে.
কিভাবে ব্যবহার করার জন্য
এটি একটি সাধারণ পাইথন প্যাকেজ এর. আপনি easy_install ব্যবহার করে এটি ইনস্টল করতে পারেন:
& Nbsp; easy_install Okydoky
এই প্যাকেজ okydoky নামক একটি কমান্ড লাইন স্ক্রিপ্ট প্রদান করে. এটি একটি ওয়েব অ্যাপ্লিকেশন এবং নিজেই জন্য একটি ছোট ওয়েব সার্ভারের. এটি একটি কনফিগ ফাইল লাগে.
কনফিগ ফাইল GitHub আবেদন কি এবং গোপন চাবি মত কিছু প্রয়োজনীয় মান ধারণ করা আছে.
আপনি Okydoky ব্যবহার করার জন্য একটি GitHub অ্যাপ্লিকেশন তৈরি করতে হবে. তার কলব্যাক URL টি খুবই গুরুত্বপূর্ণ. এটা দিয়ে পূরণ করুন:
জন্য http: // <হোস্ট> / প্রমাণীকরণ / চূড়ান্ত
এবং পরিবর্তে <হোস্ট> আপনি ব্যবহার করব কি ডোমেইন নামের সঙ্গে. এবং তারপর, আপনার GitHub সংগ্রহস্থলের মধ্যে একটি পোস্ট পাবেন হুক যোগ করুন:
জন্য http: // <হোস্ট> /
আপনি একটি কনফিগ ফাইল করা, তারপর okydoky স্ক্রিপ্ট ব্যবহার করে একটি Okydoky সার্ভার চালানো:
& Nbsp; okydoky -H 0.0.0.0 -p 8080 yourconfig.py
অবশেষে, আপনি ইনস্টল শেষ করুন একটি প্রাথমিক প্রমাণীকরণ করতে হবে. ওপেন জন্য http: // <হোস্ট> / আপনার ওয়েব ব্রাউজারে এবং সেখান থেকে GitHub দিয়ে লগইন করুন.
কনফিগারেশন
কনফিগ ফাইল একটি স্বাভাবিক পাইথন স্ক্রিপ্ট হয়. এটা বোতল এর কনফিগ সিস্টেম ব্যবহার করে. কনফিগ ফাইল সম্পর্কে বোতল এর ডক্স পড়ুন.
সংগ্রহস্থলের
& Nbsp; ব্যবহারকারী ও সংগ্রহস্থলের নাম যেমন 'Crosspop / okydoky'.
Client_id
& Nbsp; GitHub আবেদন এর ক্লায়েন্ট কি.
CLIENT_SECRET
& Nbsp; GitHub আবেদন এর গোপন চাবি.
SAVE_DIRECTORY
& Nbsp; ডিরেক্টরি পথ তথ্য সংরক্ষণ করা. এই ডিরেক্টরির কিছু কনফিগার তথ্য, tarballs, এবং নির্মিত নথি সংরক্ষণ করবে.
SECRET_KEY
& Nbsp; গোপন চাবি সেশন সাইন ইন করুন. এছাড়াও সেশন সম্পর্কে বোতল এর ডক্স দেখুন.
ওপেন সোর্স
Okydoky Crosspop জন্য Hong Minhee দ্বারা লিখিত হয়. এটা MIT- র লাইসেন্সের অধীন বিতরণ, এবং সোর্স কোড GitHub সংগ্রহস্থলের মধ্যে পাওয়া যেতে পারে. পরীক্ষা করে দেখুন:
& Nbsp; Git ক্লোন Git: //github.com/crosspop/okydoky.git
এই রিলিজে নতুন কি:
- GitHub উপভোক্তা কী জন্য রাষ্ট্র বাধ্য. যে অনুসরণ করুন.
সংস্করণ 0.9.4 নতুন কি:
- setup.py জন্য --upgrade বিকল্প ব্যবহার করুন বিকাশ কমান্ড. এই নির্ভরতা সংস্করণ দ্বন্দ্ব বাধা দেয়.
- তৈরি করুন লগ build.txt ফাইলের মধ্যে ফেলে রাখা হয়.
সংস্করণ 0.9.3 নতুন কি:
- এখন সূচক পাতা refs তালিকা দেখায়.
- এখন Okydoky সেট এর বিল্ড প্রক্রিয়ার সময় = 1 এনভায়রনমেন্ট ভেরিয়েবল OKYDOKY. [# 5]
- যুক্ত করুন / মাথা বিশেষ সুত্র URL.
- মাথা সর্বশেষ সেট না করা হয় যে একটি বাগ কমিট সংশোধন করা হয়েছে.
সংস্করণ 0.9.2 নতুন কি
- নিরাপত্তা বাগ সংশোধন করা হয়েছে: এখন ব্যবহারকারীদের থাকতে হবে একটি সংগ্রহস্থলের জন্য অনুমোদন. [4]
আবশ্যক
- পাইথন
পাওয়া মন্তব্যসমূহ না