Pywikibot/Installing - Revision history

Admin: /* Set up a family file */

2019-10-06T19:27:40Z

Set up a family file

← Older revision		Revision as of 19:27, 6 October 2019
Line 32:		Line 32:
	===Set up a family file===		===Set up a family file===

	~~Add~~ a ~~custom~~ family file to ~~the big directory of family files~~:		Before logging into a new wiki family, you need to create a family file for that wiki "family".

			Use the <code>generate_family_file.py</code> script to do that:

	<pre>		<pre>
	$ ~~ls pywikibot/families~~		$ python generate_family_file.py <url-of-wiki> <wiki-shortname>
	~~...~~
	~~wikivoyage_family.py~~
	~~wiktionary_family.py~~
	~~wowwiki_family~~.py
	</pre>		</pre>

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

	<pre>		<pre>
			$ python generate_family_file.py https://charlesreid1.com/wiki/Main_Page charlesreid1
			</pre>

			This will generate a family file at <code>pywikibot/families/charlesreid1_family.py</code> with the contents:

			<pre>
			# -- coding: utf-8 --
			"""
			This family file was auto-generated by generate_family_file.py script.

			Configuration parameters:
			url = https://charlesreid1.com/wiki/Main_Page
			name = charlesreid1

			Please do not commit this to the Git repository!
			"""
			from __future__ import absolute_import, division, unicode_literals

	from pywikibot import family		from pywikibot import family
			from pywikibot.tools import deprecated


			class Family(family.Family): # noqa: D101

	~~class Family(family~~.~~Family):~~		name = 'charlesreid1'
	def ~~__init__~~(self):		langs = {
	~~family~~.~~Family.__init__~~(self)		'en': 'charlesreid1.com',
	~~self~~.~~name = 'charlesreid1~~'		}
	self~~.langs =~~ {
	'en': '~~charlesreid1.com~~',		def scriptpath(self, code):
	}		return {
			'en': '/w',
			}[code]

			@deprecated('APISite.version()')
			def version(self, code):
			return {
			'en': '1.30.0',
			}[code]

			def protocol(self, code):
			return {
			'en': 'https',
			}[code]
	</pre>		</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).~~

	NOTE: The family file name MUST end with <code>_family</code> or it will not get picked up by the login script.		NOTE: The family file name MUST end with <code>_family</code> or it will not get picked up by the login script.

Admin: /* git.charlesreid1.com */

2019-10-06T18:56:48Z

git.charlesreid1.com

← Older revision		Revision as of 18:56, 6 October 2019
Line 96:		Line 96:
	===git.charlesreid1.com===		===git.charlesreid1.com===

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

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

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

Admin: /* Installing Pywikibot */

2019-10-06T18:33:50Z

Installing Pywikibot

← Older revision		Revision as of 18:33, 6 October 2019
Line 5:		Line 5:
	Link to pywikibot on Wikimedia Foundation's gerrit: https://gerrit.wikimedia.org/r/pywikibot/core.git		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		Link to pywikibot on git.charlesreid1.com: https://git.charlesreid1.com/wiki/pywikibot

	===Wikimedia gerrit===		===Wikimedia gerrit===

Admin: /* Set up a family file */

2018-02-01T21:56:47Z

Set up a family file

← Older revision		Revision as of 21:56, 1 February 2018
Line 30:		Line 30:
	</pre>		</pre>

	==Set up a family file==		===Set up a family file===

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

Admin: /* Set up a family file */

2018-02-01T21:56:40Z

Set up a family file

@@ Line 60: / Line 60: @@
 NOTE: The family file name MUST end with <code>_family</code> or it will not get picked up by the login script.
-Now you should be able to log into the wiki as your bot:
+The first time you run the login action script, you will be asked to set up some details about the wiki family that you have selected:
 <pre>
@@ Line 81: / Line 104: @@
 $ git push cmr master
 </pre>
 ==Flags==

Admin: /* Wikimedia gerrit */

2018-02-01T21:55:10Z

Wikimedia gerrit

← Older revision		Revision as of 21:55, 1 February 2018
Line 29:		Line 29:
	$ git submodule update --init		$ git submodule update --init
	</pre>		</pre>

			==Set up a family file==

	Add a custom family file to the big directory of family files:		Add a custom family file to the big directory of family files:
Line 55:		Line 57:

	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).		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).

			NOTE: The family file name MUST end with <code>_family</code> or it will not get picked up by the login script.

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

Admin: /* =Flags */

2018-01-31T21:59:02Z

=Flags

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


	==Flags=		==Flags==

	[[Category:Pywikibot]]		[[Category:Pywikibot]]

Admin: Created page with "==Installing Pywikibot== 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 W..."

2018-01-31T21:58:53Z

Created page with "==Installing Pywikibot== 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 W..."

New page

==Installing Pywikibot==

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>

==Flags=

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