Unknown user: Created page with "Covers how to configure Pywikibot to talk to third-party wiki sites. ==Directory Structure== The directory structure for your pywikibot script should be a top-level dire..."

2022-05-27T02:21:11Z

Created page with "Covers how to configure Pywikibot to talk to third-party wiki sites. ==Directory Structure== The directory structure for your pywikibot script should be a top-level dire..."

New page

Covers how to configure [[Pywikibot]] to talk to third-party wiki sites.

==Directory Structure==

The directory structure for your pywikibot script should be a top-level directory containing your pywikibot script, and a copy of the pywikibot repository.

For example, a bot named <code>my_bot</code> would be set up as follows (note that <code>core_stable</code> is a copy of the pywikibot core repository):

<pre>
my_bot/
my_bot_script.py
user-config.py
core_stable/
pwb.py
generate_*.py
...
</pre>

IMPORTANT:

When running scripts like <code>my_bot_script.py</code>, run them from the <code>my_bot/</code> directory.

When generating configuration files or setting up the wiki login credentials, run scripts from the <code>core_stable/</code> pywikibot repo directory.

==Create MediaWiki Bot User==

You will need to create credentials that the bot can use to make edits.

Go to [[Special:BotPasswords]] to create a bot password.

MediaWiki Documentation: https://www.mediawiki.org/wiki/Manual:Pywikibot/BotPasswords

==Create Family File==

In order to run [[Pywikibot]] on a third-party wiki, you have to tell your wiki how to interact with the third-party wiki. To do that, you need a family file.

Family files can be generated using the <code>generate_family_file.py</code> script. Run the script from the <code>core_stable/</code> directory.

<pre>
py generate_family_file.py
</pre>

This will write a family file in <code>my_bot/core_stable/pywikibot/families</code>:

<pre>
Writing /path/to/my_bot/core_stable/pywikibot/families/mythirdpartywiki_family.py...
</pre>

==Set Up Login Credentials==

Next step is to store credentials for the bot account we created.

Go to the <code>core_stable/</code> directory and use the <code>generate_user_files.py</code> script:

<pre>
py generate_user_files.py
</pre>

This will prompt for credentials, then generate some files:

<pre>
BotPassword's "bot name" for Ch4zm: Ch4zmBat
BotPassword's "password" for "Ch4zmBat" (no characters will be shown):
'/Users/charles/golly/wiki-article-generator/bot/core_stable/user-config.py' written.
'/Users/charles/golly/wiki-article-generator/bot/core_stable/user-password.py' written.
</pre>

==Use Credentials to Log In==

Now that we have stored the credentials, use them to log in and set up a bot session that pywikibot can use.

Go to <code>core_stable/</code> directory and use the provided login script to log in:

<pre>
$ py pwb.py scripts/login.py
WARNING: No user is logged in on site gollywiki:en
Logging in to gollywiki:en as Ch4zm@Ch4zmBat
Logged in on gollywiki:en as Ch4zm.
</pre>

==Where Credentials Are Stored==

The [[#Set Up Login Credentials]] step prompted for MediaWiki bot credentials. Those credentials are stored in the file <code>user-password.py</code> in the pywikibot repository directory.

The contents of the file look like this:

<pre>
$ cat orig_core_stable/user-password.py
# This is an automatically generated file used to store
# BotPasswords.
#
# As a simpler (but less secure) alternative to OAuth, MediaWiki allows bot
# users to uses BotPasswords to limit the permissions given to a bot.
# When using BotPasswords, each instance gets keys. This combination can only
# access the API, not the normal web interface.
#
# See https://www.mediawiki.org/wiki/Manual:Pywikibot/BotPasswords for more
# information.
('YourUserAccount', BotPassword('YourBotAccount', 'bot_password'))
</pre>

There is also an auto-generated <code>user-config.py</code> file that stores configuration details for the wiki.

{{PywikibotFlag}}

Pywikibot/Configuring - Revision history

Unknown user: Created page with "Covers how to configure Pywikibot to talk to third-party wiki sites. ==Directory Structure== The directory structure for your pywikibot script should be a top-level dire..."