Manuaali:Pywikibot/Asennus

This page will help you get started with Pywikibot, either on your own computer, on Toolforge, or using PAWS: A Web Shell.

On PAWS

PAWS: A Web Shell on helpoin tapa päästä alkuun Pywikibotin käytössä. Se ei vaadi asentamista ja voit käyttää web-käyttöliittymää komentojen syöttämiseen.

Running Pywikibot on PAWS

Omalla tietokoneellasi

Tämä sivu auttaa sinua asentamaan ja ajamaan Pywikibotin omalla tietokoneellasi. Tämä prosessi sisältää neljä kohtaa:

• Pythonin asennus
• Pywikibotin asennus
• Pywikibotin konfigurointi
• Skriptin ajaminen

Toolforgeissa

Toolforge tarjoaa vakaan alustan, joka mahdollistaa bottien ajamisen jatkuvasti tai tietyn aikataulun mukaan.

Pywikibotin ajaminen Toolforgeissa

Asenna Python

Imuroi ja asenna Python osoitteesta 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.

Jos sinulla on jo Python asennettuna, niin tarkista, että sen versio on riittävän uusi ajamalla python --version komentoikkunassa. 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.

On Windows please do not forget to modify PATH environment variable to make Python and pip work properly.

Riippuvuuksien asentaminen

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

Asenna Pywikibot

$ python -m pip install pywikibot

If using pip, use pwb instead of python pwb.py in examples below.

Lataa tämänhetkinen Pywikibot stable-haara: .tar.gz, .zip.

Pura tämä ladattu paketti esimerkiksi ~/pywikibot- tai %USERPROFILE%\pywikibot-kansioon.

Alternatively, you may retrieve the latest version using git or svn client from Gerrit, see Manual:Pywikibot/Gerrit#For users . This is the recommended way for active bot operators and developers to use Pywikibot.

Other versions are available at https://pywikibot.toolforge.org/.

Pywikibotin päivittäminen

Vakaan version julkaisu tapahtuu suunnilleen kolmen kuukauden välein ja on saatavilla samasta osoitteesta.

Ennen Pywikibotin päivityksen asentamista ota varmuuskopio Pywikibotin konfigurointi-tiedostoistasi ja skripteistäsi (user-config.py, mikä tahansa perhe (family) -tiedosto tai itse mahdollisesti luomasi skripti sekä mikä tahansa XML-tiedosto dumppi, jota käytät wikiä varten).

Pura uusi versio vanhan version päälle eli ylikirjoita vanhan version tiedostot.

Pywikibotin konfigurointi

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

Windows:

$ c:
$ cd "%USERPROFILE%\pywikibot"

Tietenkin hakemiston paikalle tulee sijainti, johon purit Pywikibot-paketin.

Continue with the following command to generate user configuration file:

$ python pwb.py generate_user_files

Seuraa kehotteita pywikibotin konfiguroimiseksi ja kun olet kirjoittanut salasanan, suoritetaan sisäänkirjautuminen.

Finally run the following command to log in to your wiki:

$ python pwb.py login

Hyödyntäminen kolmansien osapuolien wikien kanssa

Pywikibot on esikonfiguroitu toimimaan suuren joukon wikejä kanssa mutta ei välttämättä sen kanssa, jonka kanssa haluat työskennellä. Katso Manual:Pywikibot/Use on third-party wikis Pywikibotin konfiguroimiseksi haluamasi wikin kanssa.

Lisää konfigurointi-asetuksia

Pywikibot tarjoaa suuren määrän konfigurointi-asetuksia, joilla voit vaihtaa bottisi käyttäytymistä. Voit vaihtaa näitä asetuksia muokkaamalla 'user-config.py'-tiedostoa. Katso lista kaikista parametreista, joita voit käyttää, config.py -tiedostosta.

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.

Skriptin ajaminen

Pywikibotin mukana tulee suuri määrä skriptejä "scripts"-hakemistossa. Voit ajaa nämä kaikki seuraavasti:

$ 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

Listaus kaikista skripteistä löytyy $scripts -sivulta.

Muut riippuvuudet

Suurin osa skripteistä ei vaadi lisäpakkauksia, mutta jotkut niistä eivät toimi ilman. Nämä pakkaukset on listattu requirements.txt -tiedostossa.

Pakkausten asentamiseen voit käyttää $pip -komentoa, joka on valmiiksi asennettuna, jos sinulla on Pythonin tuore versio asennettuna. Paketin asentaminen tapahtuu komennolla:

$ python -m pip install [name of the package]

Alternatively, run the following command to install all dependencies for all scripts at once:

$ python -m pip install -r requirements.txt

Jos tarvitset lisää apua Pywikibottisi käyttöönotossa käythän #pywikibot-IRC-kanavassa ^connect tai pywikibot@-postituslistassa.