Pywikibot

https://github.com/wikimedia/pywikibot
Admin
Pywikibot is a Python library and collection of tools that interfaces with the MediaWiki API to...
Tokens:54,959
Snippets:471
Trust Score:8.3
License:MIT
Update:4 weeks ago
Show doc for...
Tokens:
Raw
### Quick start: clone and run Pywikibot

Source: https://github.com/wikimedia/pywikibot/blob/master/README.rst

Commands to clone the Pywikibot core repository, initialize submodules, install dependencies, and run a script. Also includes the alternative PyPI installation method.

```text
git clone https://gerrit.wikimedia.org/r/pywikibot/core.git
cd core
git submodule update --init
pip install -r requirements.txt
python pwb.py <script_name>
```

```text
pip install pywikibot
pwb <scriptname>
```

--------------------------------

### Minimal example script using pywikibot

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/library_usage.rst

A minimal example script showing how to create a bot by subclassing ExistingPageBot, define update_options, implement treat_page, and parse command-line arguments. The script can be invoked from the command line with options like -site, -page, and -text.

```python
import pywikibot
from pywikibot import pagegenerators
from pywikibot.bot import ExistingPageBot

class MyBot(ExistingPageBot):

    update_options = {
        'text': 'This is a test text',
        'summary': 'Bot: a bot test edit with Pywikibot.',
    }

    def treat_page(self):
        """Load the given page, do some changes, and save it."""
        text = self.current_page.text
        text += '\n' + self.opt.text
        self.put_current(text, summary=self.opt.summary)

def main():
    """Parse command line arguments and invoke bot."""
    options = {}
    gen_factory = pagegenerators.GeneratorFactory()
    # Option parsing
    local_args = pywikibot.handle_args()  # global options
    local_args = gen_factory.handle_args(local_args)  # generators options
    for arg in local_args:
        opt, sep, value = arg.partition(':')
        if opt in ('-summary', '-text'):
            options[opt[1:]] = value
    MyBot(generator=gen_factory.getCombinedGenerator(), **options).run()

if __name__ == '__main__':
    main()
```

```shell
python mybot -site:wikipedia:test -page:Sandbox -text:"A text added to the sandbox"
```

--------------------------------

### @require_version decorator example

Source: https://github.com/wikimedia/pywikibot/blob/master/tests/README.rst

Require a given MediaWiki version. Use the decorator from tests.aspects.

```python
from tests.aspects import require_version
[......]
@require_version('>=1.31.0')
def test_require_version(self):
```

--------------------------------

### Invoke custom script on Windows

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/entrypoint.rst

Run the installed script using the pwb wrapper on Windows systems.

```shell
pwb <global options> show_entities <scripts options>
```

--------------------------------

### Select Beta Wikipedia site using family:code notation

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/api_ref/families/4_betawiki_families.rst

Alternative way to create a Site object for a Beta wiki using the 'family:code' notation, as used by BaseSite.sitename. The example selects the German Beta Wikipedia.

```python
site = pywikibot.Site('betawikipedia:de')
```

--------------------------------

### Invoke custom script on Unix/macOS

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/entrypoint.rst

Run the installed script using the pwb wrapper on Unix or macOS systems.

```shell
$ pwb <global options> show_entities <scripts options>
```

--------------------------------

### Select Beta Wikipedia site using family and language code

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/api_ref/families/4_betawiki_families.rst

Use this to create a Site object for a Beta wiki by specifying the language code and the Beta family name. The example selects the German Beta Wikipedia.

```python
site = pywikibot.Site('de', 'betawikipedia')
```

--------------------------------

### Register entry point in setup.py

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/entrypoint.rst

Configure the pywikibot entry point and dependencies using setup.py.

```python
from setuptools import setup

setup(
    install_requires=[
        'pywikibot >= 9.4.0',
    ],
    entry_points={
        'pywikibot': [
            'scriptspath = wikidata_scripts:base_dir',
        ]
    }
)
```

--------------------------------

### Register entry point in setup.cfg

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/entrypoint.rst

Configure the pywikibot entry point and dependencies using setup.cfg.

```ini
[options]
install_requires =
    pywikibot >= 9.4.0

[options.entry_points]
pywikibot =
    scriptspath = wikidata_scripts:base_dir
```

--------------------------------

### Wikibase usage: get data from a repository

Source: https://github.com/wikimedia/pywikibot/blob/master/README.rst

A script that retrieves data from a Wikibase repository (e.g., Wikidata). It creates a site, gets the data repository, and fetches an item's data.

```python
import pywikibot
site = pywikibot.Site('wikipedia:en')
repo = site.data_repository()  # the Wikibase repository for given site
page = repo.page_from_repository('Q91')  # create a local page for the given item
item = pywikibot.ItemPage(repo, 'Q91')  # a repository item
data = item.get()  # get all item data from repository for this item
```

--------------------------------

### Register entry point in pyproject.toml

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/entrypoint.rst

Configure the pywikibot entry point and dependencies using pyproject.toml.

```toml
[project]
dependencies = [
    "pywikibot >= 9.4.0",
]

[project.entry-points."pywikibot"]
scriptspath = "wikidata_scripts:base_dir"
```

--------------------------------

### @require_modules decorator example

Source: https://github.com/wikimedia/pywikibot/blob/master/tests/README.rst

Require that the given list of modules can be imported. Use the decorator from tests.aspects.

```python
from tests.aspects import require_modules
[......]
@require_modules('important1', 'musthave2')
def test_require_modules(self):
```

--------------------------------

### Minimal user-config.py sample

Source: https://github.com/wikimedia/pywikibot/blob/master/docs/introduction.rst

A minimal user-config.py file is required when using Pywikibot in directory mode and recommended when used as a site package. The sample is shipped with the repository but not with the site-package.

```python
mylang = 'en'
family = 'wikipedia'
usernames['wikipedia']['en'] = 'YourUsername'
```

--------------------------------

### @unittest.skipIf decorator example

Source: https://github.com/wikimedia/pywikibot/blob/master/tests/README.rst

Skip a test if the condition is true. Refer to unittest's documentation for details.

```python
import unittest
[......]
@unittest.skipIf(check_if_fatal(), 'Something is not okay.')
def test_skipIf(self):
```

--------------------------------

### Get a Site object with get_site

Source: https://github.com/wikimedia/pywikibot/blob/master/tests/README.rst

Call get_site with the key given to the site to obtain the Site object.

```python
self.get_site('itwikt')
```
Tokens:
Raw