Manual:Pywikibot/نصب
در زیر یک کتابچه راهنمای کاربر برای کمک به شما در راه اندازی و اجرای Pywikibot در رایانه شخصی خود آورده شده است. چهار مرحله اصلی برای این فرآیند وجود دارد:
پایتون را نصب کنید
پایتون را از آدرس https://www.python.org/downloads/ دانلود و نصب کنید.
Make absolutely certain that you check the box at the bottom of the install wizard asking if you want to add Python to PATH!
That will allow you to access Python from any command prompt just by typing the keyword python.
اگر پایتون از قبل بر روی دستگاه شما نصب شده است، با اجرای python --version در یک پنجره فرمان اطمينان حاصل کنيد که نسخهٔ شما به اندازهٔ کافی جدید باشد.
To discover if Python version 3 or above is installed, run python3 --version in a console.
Ubuntu 19.04 and up comes with versions 2 & 3 installed.
Python v2 runs by default using terminal command python; to use v3, use terminal command python3.
Python 3.7 or higher is currently required to run the bot, but Python 3.8 or higher is recommended. در ویندوز لطفا فراموش نکنید که متغیر محیطی PATH را تغییر دهید تا پایتون و پیپ به درستی کار کنند.
وابستگی ها را نصب کنید
Additional packages are required to run Pywikibot. Run the following command to install these packages:
$ python -m pip install "requests>=2.20.1"
$ python -m pip install "mwparserfromhell>=0.5.2"
$ python -m pip install packaging
For Python 3.7 an additional package is required. Install it with:
$ python -m pip install importlib_metadata
An alternate MediaWiki markup parser may be installed with:
$ python -m pip install "wikitextparser>=0.47.5"
See also https://doc.wikimedia.org/pywikibot/stable/introduction.html#quick-start
نصب Pywikibot
$ python -m pip install pywikibot
If using pip, use pwb instead of python pwb.py in examples below.
شاخه فعلی Pywikibot stable را دانلود کنید: .tar.gz، .zip.
این فایل فشرده را درجایی مثل ~/pywikibot یا%USERPROFILE%\pywikibot بگشایید.
همچنین، می‌توانید آخرین نسخه را با استفاده از کلاینت git یا svn از Gerrit بازیابی کنید، به Manual:Pywikibot/Gerrit#For users مراجعه کنید. این روشی است که برای اپراتورها و توسعه دهندگان فعال ربات برای استفاده از Pywikibot توصیه می شود.
Other versions are available at https://pywikibot.toolforge.org/.
به‌روزرسانی پای‌ویکی‌بات
نسخه‌های پایدار حدوداً هر سه ماه یک بار منتشر می‌شوند و از همانجا قابل دسترس می‌باشند
قبل از نصب آن، از فایل‌های تنظیمات و اسکریپت‌ها (user-config.py، هرگونه پروندهٔ فامیلی , اسکریپت‌های سفارشی شده و هر گونه فایل های دامپ اکس‌ام‌ال که برای یک ويکی استفاده می‌کنید) نسخهٔ پشتیبان تهیه کنید.
پروندهٔ فشردهٔ نسخهٔ جدید را در محل نسخهٔ قبلی بگشایید، به شکلی که تمام پرونده‌ها بازنویسی شوند.
تنظیم کردن پای‌ویکی‌بات
Open Terminal on Unix-like (Linux/BSD/Solaris) or Command Prompt on Windows (typically under Windows System or Accessories folders in All apps or All programs menu inside the Start menu), and change directory to where you unpacked Pywikibot:
- Unix-like (Linux/BSD/Solaris):
$ cd ~/core
- ویندوز:
$ c: $ cd "%USERPROFILE%\pywikibot"
صد البته با جایگزينی مسیری که شما فایل فشردهٔ پای‌ویکی‌بات را در آن گشوده‌اید
Continue with the following command to generate user configuration file:
$ python pwb.py generate_user_files
اعلان‌ها را برای پرای تنظيمات پای‌ویکی‌بات دنبال کنید، پس از پرکردن گذرواژه، شما به سامانه وارده خواهید شد.
Finally run the following command to log in to your wiki:
$ python pwb.py login
استفاده بر روی ویکی‌های متفرقه
پای‌ویکی‌بات برای ویکی‌های بسیاری از قبل تنظیم شده است، ولی ممکن است در مورد آن ویکی که شما بر روی آن کار می‌کنید اين اتفاق نیافتاده باشد. برای تنظیم پای‌ویکی‌بات برای ویکی خودتان Manual:Pywikibot/Use on third-party wikis را ببینید
تنظیمات بیشتر
پای‌ویکی‌بات طیف وسیعی از گرینه‌های تنظیماتی را برای تغيير رفتارهای ربات شما در دسترس قرار می‌دهد شما می توانیداینتنظیمات را در پروندهٔ 'user-config.py' تغِِر دهید. برای مشاهدهٔ تمام پارامترهایی که می‌توانید استفاده کنید، config.py را ببينید
Proxy configuration
Pywikibot relies on requests for communicating with the web.
You can use HTTP_PROXY and HTTPS_PROXY environment variables to make requests use a proxy server.
Refer to requests' documentation for more info.
اجرای اسکریپت
پای‌ویکی‌بات همراه با انبوهی از اسکریپت‌ها در پوشهٔ scripts بسته بندی شده است می‌توانید تمام آنها را اجرا کنید با استفاده از
$ python pwb.py [name of the script]
To learn more about running basic Pywikibot scripts, see:
- Small wiki toolkits workshop about running basic Pywikibot scripts
- Self-study materials based on the small wiki toolkits workshop
- Workshop handbook based on the small wiki toolkits workshop
لیستی از تمامی اسکریپت‌ها در $scripts قابل دسترس است
وابستگی‌ها
اکثر اسکریپت‌ها به بسته‌های نرم‌افزاری دیگری برای اجرا نیاز ندارند،لیکن اسکریپت‌هایی هم وجود دارند که بدون بسته‌های اضافی کار نخواهند کرد. اینها در بخش requirements.txt لیست شده‌اند
برای نصب وابستگی‌ها از $pip استفاده کنید، چراکه در صورت به‌روز بودن نسخهٔ پایتون خود این ابزار برای شما نصب شده است. دستورهای زیر را برای نصب بسته‌ها اجرا کنید:
$ python -m pip install [name of the package]
یا دستور زیر برای نصب کلیهٔ بسته‌های پیشنهادی:
$ python -m pip install -r requirements.txt
- If you need more help on setting up your Pywikibot visit the #pywikibot IRC channel connect or pywikibot@ mailing list.