====Pywikibot====

[[tools:mediawiki|Mediawiki]] automation scripts.

===Clone===

<code>
git clone --recursive https://github.com/wikimedia/pywikibot
</code>

Perform all future operations inside the pywikibot repository directory.

<code>
cd pywikibot
</code>

===Install===

==Environment==

<code>
python3 -m venv ~/.venvs/pywikibot
</code>

==Activate==

__TCSH__
<code>
source ~/.venvs/pywikibot/bin/activate.csh
</code>

==Requirements==
<code>
python -m pip install -r requirements.txt
</code>

==Tool==

<code>
python -m pip install .
</code>

__TCSH__
<code>
rehash
</code>

===Config===

First create a family file.

<code>
pwb generate_family_file.py
</code>

Enter the URL and name to create a family file for the private site.
Select no when asked about interwiki links. 

Eg.
<code>
from pywikibot import family

class Family(family.Family):  # noqa: D101
    name = 'MySite'
    langs = {
        'en': 'www.example.com',
    }

    def version(self, code):
        return "1.4.3"  # The MediaWiki version used.

    def scriptpath(self, code):
        return {
            'en': '/w',
        }[code]

    def protocol(self, code):
        return {
            'en': 'https',
        }[code]
</code>

Next a user configuration is needed.
<code>
cp user-config.py.sample user-config.py
vi user-config.py
</code>

Eg.
<code>
mylang = 'en'
family = 'MySite'
usernames['MySite']['en'] = 'Mybot'
</code>

Lastly run the login script to enter the password.

<code>
pwb login -v -v
</code>

===Example===

<code>
pwb <script_name>
</code>

===Resources====

[[https://github.com/wikimedia/pywikibot|Github]]|

[[https://doc.wikimedia.org/pywikibot/stable/|Documentation]]

[[https://www.mediawiki.org/wiki/Manual:Pywikibot/Use_on_third-party_wikis|Third party wikis]]

[[https://www.mediawiki.org/wiki/Manual:Pywikibot/Wikidata|Wikidata]]

[[https://doc.wikimedia.org/pywikibot/stable/api_ref/pywikibot.config.html|User configuration]]

[[https://www.mediawiki.org/wiki/Manual:Pywikibot/Create_your_own_script|User scripts]]