Ladsgroup has submitted this change and it was merged. Change subject: Overhaul README file with more information ...................................................................... Overhaul README file with more information Now includes how to install the framework, a simple code snippet, and a link on how to contribute patches. Change-Id: I112b53e0a2a3767e459323a34dc012ccc05201bd --- M README.md 1 file changed, 30 insertions(+), 6 deletions(-) Approvals: Ladsgroup: Verified; Looks good to me, approved diff --git a/README.md b/README.md index 3592013..7acbc43 100644 --- a/README.md +++ b/README.md @@ -1,10 +1,34 @@ -# Python Wikipedia Robot Framework +# Pywikibot Framework [. +Also included are various general function scripts that can be adapted for different tasks. -If you want to run the rewrite as a stand-alone package, please also download the -the contents of the externals/ subdirectory. Confer externals/README for more -information. +## Quick start +``` +git clone https://gerrit.wikimedia.org/r/pywikibot/core.git +cd core +git submodule update --init +python pwb.py script_name +``` + +Our [installation guide](https://www.mediawiki.org/wiki/Manual:Pywikipediabot/Installation) has more details for advanced usage. + +## Usage + +If you wish to write your own script it's very easy to get started: + +```python +import pywikibot +site = pywikibot.Site('en', 'wikipedia') # The site we want to run our bot on +page = pywikibot.Page(site, 'Wikipedia:Sandbox') +text = page.get() # The current text on the page +text = text.replace('foo', 'bar') +page.put(text, 'Replacing "foo" with "bar"') # Saves the page +``` + +## Contributing + +Our code is maintained on Wikimedia's [Gerrit installation](https://gerrit.wikimedia.org/), [learn](https://www.mediawiki.org/wiki/Developer_access) how to get started. + -- To view, visit https://gerrit.wikimedia.org/r/82076 To unsubscribe, visit https://gerrit.wikimedia.org/r/settings Gerrit-MessageType: merged Gerrit-Change-Id: I112b53e0a2a3767e459323a34dc012ccc05201bd Gerrit-PatchSet: 1 Gerrit-Project: pywikibot/core Gerrit-Branch: master Gerrit-Owner: Legoktm <legoktm.wikipedia(a)gmail.com> Gerrit-Reviewer: Ladsgroup <ladsgroup(a)gmail.com> Gerrit-Reviewer: Legoktm <legoktm.wikipedia(a)gmail.com> Gerrit-Reviewer: Merlijn van Deen <valhallasw(a)arctus.nl> Gerrit-Reviewer: Multichill <maarten(a)mdammers.nl> Gerrit-Reviewer: Xqt <info(a)gno.de> Gerrit-Reviewer: jenkins-bot