Manual:Pywikibot/PAWS/id

Dokumen ini menyajikan gambaran singkat dan interaktif terkait penggunaan Pywikibot dengan menggunakan 'laptop' berprogram 'PAWS' (Pywikibot: A Web Shell) yang diinangkan di lab Wikimedia.

Cara pembuatan akun Wikimedia
Untuk bisa mengikuti tata langkah berikut, Anda hanya perlu membuat akun pada salah satu proyek Wikimedia.

Untuk membuat akun Wikimedia, kunjungi laman bantuan Log Masuk. (Hindari penggunaan karakter khusus, hingga T120066 sudah diperbaiki.)

Jika Anda sudah membuat akun, kunjungi https://test.wikipedia.org/ dan perhatikan nama pengguna Anda yang muncul di pojok kanan atas. (Proses ini akan berjalan lancar sesuai T120327).

Masuk ke 'laptop'
Untuk memulai 'laptop inang', silakan pergi ke https://tools.wmflabs.org/paws

Klik "Sign in with MediaWiki", kemudian klik "Allow" jika diminta untuk persetujuan terkait "Use OAuth for Authentication".

Saat pertama kali mengakses PAWS, Anda diharuskan untuk membuat server.

Saat server sudah dibuat Anda akan dialihkkan ke pranala seperti ini, https://tools.wmflabs.org/paws/user/ /tree

Memulai terminal
Untuk memulai terminal interaktif yang baru:
 * 1) Pergi ke laman utama PAWS
 * 2) Klik 'New' pada pojok kanan, dan
 * 3) Pilih 'Terminal'.

Kemudian jendela baru akan terbuka dengan pranala https://tools.wmflabs.org/paws/user/ /terminals/1, dan prompt Linux '$'

Anda bisa memberikan markah buku pada pranala ini dan kembali ke terminal sepanjang saat, bahkan jika Anda telah menutup peramban atau mematikan komputer.

Terminal ini bukanlah emulator. Terminal ini layaknya sebuah bash shell yang merupakan bagian dari dudukan instalasi Linux pada docker container. Jadi, Anda bisa menggunakan perintah bash apapun dan perintah manapun yang tersedia pada sistem operasi Linux yang telah diinstal.

Untuk melihat beberapa perintah yang tersedia, gunakan.

Masuk ke Wiki
Pywikibot membutuhkan sebuah berkas konfigurasi 'user-config.py' yang biasanya dibuat secara otomatis oleh PAWS dengan https://test.wikipedia.org/ sebagai wiki terpilih.

Perintah berikutnya untuk memastikan bahwa Anda dapat masuk ke https://test.wikipedia.org/. Perintah ini menggunakan otorisasi otomatis sehingga tidak perlu memasukkan kata sandi lagi.

Membuat laman
Untuk membuat sebuah laman, masukkan perintah berikut ke terminal, ganti ' ' dengan nama pengguna Anda, lalu tekan 'Y' saat diminta untuk menyetujui perubahan yang Anda lakukan:

Anda sudah berhasil menyunting Wiki. Lihat perubahan yang Anda lakukan dengan membuka https://test.wikipedia.org/wiki/User_talk: pada peramban web Anda.

You can read more about each of these command line scripts with the '-help' command line option.

Fetch a page
Fetching many pages is achieved with the "listpages" command.

To get the contents of the page you created in the previous section, enter the following command:

Now if you go to your PAWS files list, the saved page should be present.

A real script example
When a website used on Wikipedia changes its URL, the links on Wikipedia become outdated, and possible also dead links if the website doesn't redirect from the old URLs to the new URLs. e.g. for example, Encyclopedia Britannica (EB) has changed their links, such as moving pages from http://www.britannica.com/EBchecked/media/ to http://www.britannica.com/topic/[topic name]/images-videos/*. You can find the list of usages of the old URL on English Wikipedia at https://en.wikipedia.org/wiki/Special:LinkSearch/http://www.britannica.com/EBchecked/media. Updating all those links manually will be very time consuming. Thankfully EB has maintained redirects from their old URLs to the new URLs, so this does not need to be fixed immediately.

For a simpler example, English Wikipedia currently contains links to http://britannica.com/EBchecked/ instead of http://www.britannica.com/EBchecked/ ; i.e. a 'www.' subdomain is missing in the URL.

There are currently 14 cases on English Wikipedia: https://en.wikipedia.org/wiki/Special:LinkSearch/http://britannica.com/EBchecked/

Wikipedia in other language also have this problem. e.g. there is one case on German Wikipedia: https://de.wikipedia.org/wiki/Spezial:Weblinksuche/http://britannica.com/EBchecked/

In order to fix those links, we can use Pywikibot replace.py script. In this demo we will use the '-simulate' argument to avoid writing to the wiki, as there are strict rules about automated editing of English Wikipedia.

First lets list all of the pages which link to http://britannica.com/EBchecked/.

Now we check those pages actually have the literal URL in the page; i.e. they are not using a template.

Now use replace to add the missing "www."

In PAWS, and any terminal that supports color, the diff of changes will show the added "www." in green text color, making it easier to find the proposed changes.

Inside Pywikibot
Next we will use the PAWS Python session.


 * 1) Go to your PAWS home,
 * 2) click 'New' on the right hand side, and
 * 3) select 'Python 3'.

This will open a new window.

In the text box, enter the following and in the Cell menu select 'Run' (or pressing shift+enter to run).

A new text box will appear below. Run the following to create an APISite object connected to https://test.wikipedia.org/:

Describe "site" by entering it into the new text box and selecting "Run".

It should show

Out[3]: APISite("test", "wikipedia")

Create a page object:

Check it exists by running:

It should output

VERBOSE:pywiki:Found 1 wikipedia:test processes running, including this one. Out[5]: True

Show the text on the page:

Change the page text in the object:

Save the page to the wiki:

The response should be:

The interactive Python 3 notebook allows many lines to be run together. The above could be put into one text box and Run

The log of your interactive Python session can be saved or downloaded for future reference.

Accessing online documentation in PAWS
Pywikibot documentation may be found at https://doc.wikimedia.org/pywikibot/index.html. It is primarily sourced from docstrings, which can be loaded in the interactive Python 3 notebook using the Python built-in function help.

For example, to look at the arguments for the save method above, run either:

or

Editing Pywikibot scripts
The Pywikibot library and scripts are located in /srv/pwb, and are read-only. The installed Pywikibot library can not be modified in PAWS.

Scripts may be modified after copying them into your PAWS home.

To run a modified "checkimages.py"
 * 1) In the terminal, enter "cp /srv/pwb/scripts/checkimages.py ~"
 * 2) Click on the file checkimages.py in your PAWS home
 * 3) Edit the code and save your modifications
 * 4) In the terminal, enter "pwb.py ~/checkimages.py -simulate"