Pywikibot - Revision history

Unknown user: /* Installing Pywikibot */

2022-05-27T02:20:59Z

Installing Pywikibot

← Older revision		Revision as of 02:20, 27 May 2022
Line 4:		Line 4:

	See [[Pywikibot/Installing]]		See [[Pywikibot/Installing]]

			==Configuring Pywikibot==

			See [[Pywikibot/Configuring]]

	==Running Simple Scripts==		==Running Simple Scripts==

Admin: /* Redirect.py Script */

2019-10-09T01:42:45Z

Redirect.py Script

← Older revision		Revision as of 01:42, 9 October 2019
Line 21:		Line 21:
	===Redirect.py Script===		===Redirect.py Script===

	Suppose we wanted to run the script <code>redirect.py</code> to programmatically deal with redirects on our wiki. ~~We can start~~ by ~~looking~~ at the ~~documentation for this~~ file~~, which shows us there are many options for this script~~:		Suppose we wanted to run the script <code>redirect.py</code> to programmatically deal with redirects on our wiki.

			Start by opening the script <code>scripts/redirect.py</code> in a text editor. The docstring at the top of the file will show some basic information:

	~~{{Scrollbox\|~~
	<pre>		<pre>
			"""
	Script to resolve double redirects, and to delete broken redirects.		Script to resolve double redirects, and to delete broken redirects.

Line 92:		Line 94:

	-always Don't prompt you for each replacement.		-always Don't prompt you for each replacement.
			"""
	</pre>		</pre>
	}}

	Suppose we want to eliminate double-redirects. To do this, we run the redirect script through pwb.py, and pass it the double argument like so:		Suppose we want to eliminate double-redirects. To do this, we run the redirect script through pwb.py, and pass it the double argument like so:

Admin at 01:40, 9 October 2019

2019-10-09T01:40:19Z

← Older revision		Revision as of 01:40, 9 October 2019
Line 1:		Line 1:
	~~Setting this up is confusing as hell, mainly because the documentation is lacking.~~

	Pywikibot is a single standalone Python script that works a little bit like a framework. To use it, you assemble various "actions", and run each action through the pywikibot Python script. The first action you'll usually run is the login action, which stores credentials for a wiki. Then, you can run any of the other built-in actions, or define your own actions.		Pywikibot is a single standalone Python script that works a little bit like a framework. To use it, you assemble various "actions", and run each action through the pywikibot Python script. The first action you'll usually run is the login action, which stores credentials for a wiki. Then, you can run any of the other built-in actions, or define your own actions.

Admin: /* Installing Pywikibot */

2018-01-31T21:59:13Z

Installing Pywikibot

← Older revision		Revision as of 21:59, 31 January 2018
Line 6:		Line 6:

	See [[Pywikibot/Installing]]		See [[Pywikibot/Installing]]

	~~I have the pywikibot software set up with two remotes: one official (Wikimedia gerrit), and one unofficial (my own git repo).~~

	~~Link to pywikibot on Wikimedia Foundation's gerrit: https://gerrit.wikimedia.org/r/pywikibot/core.git~~

	~~Link to pywikibot on git.charlesreid1.com: https://charlesreid1.com:3000/wiki/pywikibot~~

	~~===Wikimedia gerrit===~~

	~~Note the official pywikibot repo is also cloned on Github: https://github.com/wikimedia/pywikibot-core/~~

	~~Start by checking it out:~~

	~~<pre>~~
	~~$ git clone https://gerrit.wikimedia.org/r/pywikibot/core.git pywikibot~~
	~~$ cd pywikibot~~
	~~</pre>~~

	~~Install all the pip stuff that you may need:~~

	~~<pre>~~
	~~$ pip install -r requirements.txt~~
	~~</pre>~~

	~~Update git submodules:~~

	~~<pre>~~
	~~$ git submodule update --init~~
	~~</pre>~~

	~~Add a custom family file to the big directory of family files:~~

	~~<pre>~~
	~~$ ls pywikibot/families~~
	~~...~~
	~~wikivoyage_family.py~~
	~~wiktionary_family.py~~
	~~wowwiki_family.py~~
	~~</pre>~~

	~~This is where you will put your custom family file. Here's what the custom family file looks like:~~

	~~<pre>~~
	~~from pywikibot import family~~

	~~class Family(family.Family):~~
	~~def __init__(self):~~
	~~family.Family.__init__(self)~~
	~~self.name = 'charlesreid1'~~
	~~self.langs = {~~
	~~'en': 'charlesreid1.com',~~
	}
	~~</pre>~~

	~~Copy and paste this into <code>pwb/pywikibot/families/charlesreid1_family.py</code> (where pwb is the name of the directory where you checked out the git repository).~~

	~~Now you should be able to log into the wiki as your bot:~~

	~~<pre>~~
	~~$ python pwb.py login~~
	~~Password for user Bleep bloop on charlesreid1:en (no characters will be shown):~~

	~~Logging in to charlesreid1:en as Bleep bloop~~
	~~WARNING: /Users/charles/codes/pywikibot/pywikibot/tools/__init__.py:1717: UserWarning: File /Users/charles/codes/pywikibot/pywikibot.lwp had 644 mode; converted to 600 mode.~~
	~~Logged in on charlesreid1:en as Bleep bloop.~~
	~~</pre>~~

	~~===git.charlesreid1.com===~~

	~~Link to pywikibot on git.charlesreid1.com: https://charlesreid1.com:3000/wiki/pywikibot~~

	~~To push changes to the pywikibot on git.charlesreid1.com I set up the repo with another remote:~~

	~~<pre>~~
	~~$ git remote add cmr https://charlesreid1.com:3000/wiki/pywikibot~~
	~~$ git push cmr master~~
	~~</pre>~~

	==Running Simple Scripts==		==Running Simple Scripts==

Admin: /* Getting, Configuring, Installing */

2018-01-31T21:58:02Z

Getting, Configuring, Installing

← Older revision		Revision as of 21:58, 31 January 2018
Line 3:		Line 3:
	Pywikibot is a single standalone Python script that works a little bit like a framework. To use it, you assemble various "actions", and run each action through the pywikibot Python script. The first action you'll usually run is the login action, which stores credentials for a wiki. Then, you can run any of the other built-in actions, or define your own actions.		Pywikibot is a single standalone Python script that works a little bit like a framework. To use it, you assemble various "actions", and run each action through the pywikibot Python script. The first action you'll usually run is the login action, which stores credentials for a wiki. Then, you can run any of the other built-in actions, or define your own actions.

	==~~Getting, Configuring,~~ Installing==		==Installing Pywikibot==

			See [[Pywikibot/Installing]]

	I have the pywikibot software set up with two remotes: one official (Wikimedia gerrit), and one unofficial (my own git repo).		I have the pywikibot software set up with two remotes: one official (Wikimedia gerrit), and one unofficial (my own git repo).

Admin: /* Using Custom Scripts from Outside Pywikibot Directory */

2018-01-31T21:56:47Z

Using Custom Scripts from Outside Pywikibot Directory

← Older revision		Revision as of 21:56, 31 January 2018
Line 187:		Line 187:

	[[Pywikibot/Scraping]] - how to write a MediaWiki scraper		[[Pywikibot/Scraping]] - how to write a MediaWiki scraper

	~~==Using Custom Scripts from Outside Pywikibot Directory==~~

	~~You can install pywikibot and import it from anywhere (e.g., /tmp), but you will need to include a user config file. If you try to import pywikibot without a user-config file,~~

	~~<pre>~~
	~~import pywikibot~~
	~~</pre>~~

	~~you'll see this RuntimeError:~~

	~~<pre>~~
	~~RuntimeError: No user-config.py found in directory '/tmp'.~~
	~~Please check that user-config.py is stored in the correct location.~~
	~~Directory where user-config.py is searched is determined as follows:~~

	~~Return the directory in which user-specific information is stored.~~

	~~This is determined in the following order:~~
	~~1. If the script was called with a -dir: argument, use the directory~~
	~~provided in this argument.~~
	~~2. If the user has a PYWIKIBOT2_DIR environment variable, use the value~~
	~~of it.~~
	~~3. If user-config is present in current directory, use the current~~
	~~directory.~~
	~~4. If user-config is present in pwb.py directory, use that directory~~
	~~5. Use (and if necessary create) a 'pywikibot' folder under~~
	~~'Application Data' or 'AppData\Roaming' (Windows) or~~
	~~'.pywikibot' directory (Unix and similar) under the user's home~~
	~~directory.~~

	~~Set PYWIKIBOT2_NO_USER_CONFIG=1 to disable loading user-config.py~~

	~~@param test_directory: Assume that a user config file exists in this~~
	~~directory. Used to test whether placing a user config file in this~~
	~~directory will cause it to be selected as the base directory.~~
	~~@type test_directory: str or None~~
	~~@rtype: unicode~~
	~~</pre>~~

	~~When you are in the pywikibot directory, and you run the login script,~~

	~~<pre>~~
	~~python pwb.py login~~
	~~</pre>~~

	~~this will create a user-config.py configuration file with (almost entirely superfluous) information about the wiki you log into.~~

	~~From there, it will work pretty much like it did before:~~

	~~<pre>~~
	~~In [1]: import pywikibot~~

	~~In [2]: s = pywikibot.Site()~~

	~~In [3]: s~~
	~~Out[3]: APISite("en", "charlesreid1")~~


	~~In [5]: pywikibot.Page(s,'Linux/Wireless')~~
	~~Out[5]: Page('Linux/Wireless')~~


	~~In [8]: hist = list(p.fullVersionHistory())~~
	~~WARNING: /Users/charles/Library/Python/3.6/bin/ipython:1: DeprecationWarning: pywikibot.page.BasePage.fullVersionHistory is deprecated; use Page.revisions(content=True) instead.~~
	~~#!/usr/local/opt/python3/bin/python3.6~~


	~~In [10]: hist = list(p.revisions(content=False))~~

	~~In[11]: hist[0:3]~~
	~~Out[11]:~~
	[{'revid': 16262, 'text': None, 'timestamp': Timestamp(2017, 4, 15, 6, 35, 29), 'user': 'Admin', 'anon': False, 'comment': '/* Flags */', 'minor': False, 'rollbacktoken': None, '_parent_id': 16261, '_content_model': 'wikitext', '_sha1': 'df790e36c30e7895fea4e114d40d3515c0345b23'},
	{'revid': 16261, 'text': None, 'timestamp': Timestamp(2017, 4, 15, 6, 32, 26), 'user': 'Admin', 'anon': False, 'comment': '/* Joining network with WPA encryption */', 'minor': False, 'rollbacktoken': None, '_parent_id': 16260, '_content_model': 'wikitext', '_sha1': '430d06d81ecca002199b895b4ab8de76615f86a2'},
	{'revid': 16260, 'text': None, 'timestamp': Timestamp(2017, 4, 15, 6, 31, 10), 'user': 'Admin', 'anon': False, 'comment': '/* WPA Supplicant Method */', 'minor': False, 'rollbacktoken': None, '_parent_id': 16259, '_content_model': 'wikitext', '_sha1': 'ca1ee6ab00d2305992c71c14127e0fc474476a84'}]

	~~In [12]: print(type(hist[0]))~~

	~~In [19]: revision_dictionary = dict(hist[0].__dict__)~~

	~~In [20]: print(revision_dictionary.keys())~~
	~~dict_keys(['revid', 'text', 'timestamp', 'user', 'anon', 'comment', 'minor', 'rollbacktoken', '_parent_id', '_content_model', '_sha1'])~~
	~~<class 'pywikibot.page.Revision'>~~




	~~..............................................~~




	~~In [49]: all_pages = list(site.allpages())~~

	~~In [50]: print(type(all_pages))~~
	~~<class 'list'>~~

	~~In [51]: print(len(all_pages))~~
	~~2292~~

	~~In [52]: print(type(all_pages[0]))~~
	~~<class 'pywikibot.page.Page'>~~

	~~</pre>~~


	==Page Objects==		==Page Objects==

Admin: /* Using Custom Scripts from Pywikibot Directory */

2018-01-31T21:55:29Z

Using Custom Scripts from Pywikibot Directory

Show changes

Admin at 21:34, 31 January 2018

2018-01-31T21:34:22Z

← Older revision		Revision as of 21:34, 31 January 2018
Line 905:		Line 905:
	==Flags==		==Flags==


			[[Category:Pywikibot]]
			[[Category:Bots]]
	[[Category:MediaWiki]]		[[Category:MediaWiki]]
	[[Category:~~Bots~~]]		[[Category:Python]]
			[[Category:Charlesreid1]]

Admin: /* Using Custom Scripts from Pywikibot Directory */

2018-01-31T21:25:51Z

Using Custom Scripts from Pywikibot Directory

@@ Line 177: / Line 177: @@
 $ python pwb.py redirect double
 </pre>
 ==Using Custom Scripts from Pywikibot Directory==

Admin: /* Using Custom Scripts from Outside Pywikibot Directory */

2018-01-31T21:23:47Z

Using Custom Scripts from Outside Pywikibot Directory

Show changes