View source for Manual:Pywikibot/Wikidata

<languages/>
{{Ptag|Pywikibot-Wikidata}}
{{Pywikibot}}
<translate>
<!--T:1-->
This page explains how to create python bots on [[<tvar name=1>m:Special:MyLanguage/Wikidata</tvar>|Wikidata]] using the basic pywikibot library.

<!--T:2-->
If you just want to run some scripts without writing a line of Python, see [[<tvar name=1>Special:MyLanguage/Manual:Pywikibot/Scripts#Wikidata</tvar>|the included Wikidata scripts]].
</translate>

{{caution|1=<translate><!--T:41--> The methods and results may be changed in the future, as Wikibase evolves.</translate>}}
{{note|1=<translate><!--T:69--> Pywikibot supports lexical data objects like Lexemes with release 7.2 and above. </translate>}}

<translate>
== Configuration == <!--T:5-->

<!--T:6-->
To start contributing/testing using your bot's account you must add the following to your <tvar name=2>{{ll|Manual:Pywikibot/user-config.py|user-config.py}}</tvar>:

<!--T:42-->
;Production site
</translate>

<syntaxhighlight lang="python" style="overflow:auto;">
usernames['wikidata']['wikidata'] = 'YourBot'
</syntaxhighlight>

<translate>
<!--T:43-->
;Testing site
</translate>

<syntaxhighlight lang="python" style="overflow:auto;">
usernames['wikidata']['test'] = 'YourBot'
</syntaxhighlight>

<translate>
== Example == <!--T:40-->

<!--T:52-->
'''''see [[<tvar name=1>d:Special:MyLanguage/Wikidata:Creating a bot</tvar>|Wikidata:Creating a bot]]''''' for an extended documentation. pywikibot core supports most Wikibase features already, e.g., qualifiers, sources, properties with item, coordinate, time, and string type.
</translate>

<syntaxhighlight lang="python" style="overflow:auto;">
import pwb  # <translate nowrap><!--T:56--> only needed if you haven't installed the framework as side-package</translate>
import pywikibot
site = pywikibot.Site('wikipedia:en')  # <translate nowrap><!--T:57--> any site will work, this is just an example</translate>
page = pywikibot.Page(site, 'Douglas Adams')
item = pywikibot.ItemPage.fromPage(page)  # <translate nowrap><!--T:58--> this can be used for any page object</translate>
# <translate nowrap><!--T:59--> you can also define an item like this</translate>
repo = site.data_repository()  # <translate nowrap><!--T:60--> this is a DataSite object</translate>
item = pywikibot.ItemPage(repo, 'Q42')  # <translate nowrap><!--T:61--> This will be functionally the same as the other item we defined</translate>

item.get()  # <translate nowrap><!--T:62--> you need to call it to access any data.</translate>
sitelinks = item.sitelinks
aliases = item.aliases
if 'en' in item.labels:
    print('The label in English is: ' + item.labels['en'])
if item.claims:
    if 'P31' in item.claims: # instance of
        print(item.claims['P31'][0].getTarget())
        print(item.claims['P31'][0].sources[0])  # <translate nowrap><!--T:63--> let's just assume it has sources.</translate>

# <translate nowrap><!--T:64--> Edit an existing item</translate>
item.editLabels(labels={'en': 'Douglas Adams'}, summary='Edit label')
item.editDescriptions(descriptions={'en': 'English writer'}, summary='Edit description')
item.editAliases(aliases={'en': ['Douglas Noel Adams', 'another alias']})
item.setSitelink(sitelink={'site': 'enwiki', 'title': 'Douglas Adams'}, summary='Set sitelink')
item.removeSitelink(site='enwiki', summary='Remove sitelink')

# <translate nowrap><!--T:65--> You can also make this all in one time:</translate>
data = {'labels': {'en': 'Douglas Adams'},
        'descriptions': {'en': 'English writer'},
        'aliases': {'en': ['Douglas Noel Adams', 'another alias'], 'de': ['Douglas Noel Adams']},
        'sitelinks': [{'site': 'enwiki', 'title': 'Douglas Adams'}]}
item.editEntity(data, summary='Edit item')
</syntaxhighlight>

<translate>

== See also == <!--T:53-->
</translate>
* {{ll|Manual:Pywikibot/Scripts#Wikidata|2=<translate><!--T:54--> Wikidata scripts</translate>}}
* [[d:Special:MyLanguage/Wikidata:Creating a bot|Wikidata:Creating a bot]]
* [[d:Special:MyLanguage/Wikidata:Pywikibot - Python 3 Tutorial|Wikidata:Pywikibot - Python 3 Tutorial]]
* [[m:Special:MyLanguage/Small wiki toolkits/Workshops#How to interact with Wikidata via _Pywikibot|<translate><!--T:70--> How to interact with Wikidata via Pywikibot</translate>]] - <translate><!--T:71--> a workshop by [[User:Mike Peel]]</translate>

<translate>
=== Some bot examples === <!--T:66-->

<!--T:67-->
* [<tvar name=link>https://github.com/mpeel/wikicode/blob/master/example.py</tvar> Example pywikibot code] by [[User:Mike Peel]]</translate>
<translate>
<!--T:68-->
* [<tvar name=link>https://github.com/multichill/toollabs/tree/master/bot/wikidata</tvar> Collection of Wikidata bots] by [[User:Multichill]]
</translate>

{{Bothelp}}
[[Category:Pywikibot{{#translation:}}|Wikidata]]
[[Category:Wikidata{{#translation:}}|Pywikibot]]