Revision: 6548 Author: nicdumz Date: 2009-03-24 02:48:53 +0000 (Tue, 24 Mar 2009) Log Message: ----------- Moving scripts/ and tests/ a directory below, to keep only pywikibot core in the module directory Added Paths: ----------- branches/rewrite/README-conversion.txt branches/rewrite/scripts/ branches/rewrite/tests/ Removed Paths: ------------- branches/rewrite/pywikibot/README-conversion.txt branches/rewrite/pywikibot/scripts/ branches/rewrite/pywikibot/tests/ Copied: branches/rewrite/README-conversion.txt (from rev 6547, branches/rewrite/pywikibot/README-conversion.txt) =================================================================== --- branches/rewrite/README-conversion.txt (rev 0) +++ branches/rewrite/README-conversion.txt 2009-03-24 02:48:53 UTC (rev 6548) @@ -0,0 +1,110 @@ +This is a guide to converting bot scripts from version 1 of the +Pywikipediabot framework to version 2. + +Most importantly, note that the version 2 framework *only* supports wikis +using MediaWiki v.1.14 or higher software. If you need to access a wiki that +uses older software, you should continue using version 1 for this purpose. + +The root namespace used in the project has changed from "wikipedia" +to "pywikibot". References to wikipedia need to be changed globally to +pywikibot. Unless noted in this document, other names have not changed; for +example, wikipedia.Page can be replaced by pywikibot.Page throughout any +bot. An effort has been made to design the interface to be as backwards- +compatible as possible, so that in most cases it should be possible to convert +scripts to the new interface simply by changing import statements and doing +global search-and-replace on module names, as discussed in this document. + +With pywikipedia scripts were importing "wikipedia" or "pagegenerators" +libraries; pywikibot is now written as a standard package, and other modules +are contained within it (e.g., pywikibot.site contains Site classes). However, +most commonly-used names are imported into the pywikibot namespace, so that +module names don't need to be used unless specified in the documentation. + +Make sure that the directory that contains the "pywikibot" subdirectory (or +folder) is in sys.path. + +The following changes, at a minimum, need to be made to allow scripts to run: + + change "import wikipedia" to "import pywikibot" + change "import pagegenerators" to "from pywikibot import pagegenerators" + change "import config" to "from pywikibot import config" + change "import catlib" to "from pywikibot import catlib" + change "wikipedia." to "pywikibot." + +wikipedia.setAction() no longer works; you must revise the script to pass an +explicit edit summary message on each put() or put_async() call. + +== Python librairies == + +[Note: the goal will be to package pywikibot with setuptools easy_install, +so that these dependencies will be loaded automatically when the package is +installed, and users won't need to worry about this...] + +To run pywikibot, you will need the httplib2, simplejson, and setuptools +packages-- +* httplib2 : http://code.google.com/p/httplib2/ +* setuptools : http://pypi.python.org/pypi/setuptools/ +* simplejson : http://svn.red-bean.com/bob/simplejson/tags/simplejson-1.7.1/docs/index.html + +or, if you already have setuptools installed, just execute +'easy_install httplib2' and 'easy_install simplejson' + +If you run into errors involving httplib2.urlnorm, update httplib2 to 0.4.0 +(Ubuntu package python-httlib2, for example, is outdated). Note that +httplib2 will run under Python 2.6, but will emit DeprecationWarnings (which +are annoying but don't affect the ability to use the package). + +== Page objects == + +The constructor syntax for Pages has been modified; existing calls in the +format of Page(site, title) will still work, and this is still the preferred +way of creating a Page object from data retrieved from the MediaWiki API +(because the API will have parsed and normalized the title). However, for +titles input by a user or scraped from wikitext, it is preferred to use the +alternative syntax Page(Link(site, wikitext)), where "wikitext" is the +string found between [[ and ]] delimiters. The new Link object (more on +this below) handles link parsing and interpretation that doesn't require +access to the wiki server. + +A third syntax allows easy conversion from a Page object to an ImagePage or +Category, or vice versa: e.g., Category(pageobj) converts a Page to a +Category, as long as the page is in the category namespace. + +The following methods of the Page object have been deprecated (deprecated +methods still work, but print a warning message in debug mode): + +- urlname(): replaced by Page.title(asUrl=True) +- titleWithoutNamespace(): replaced by Page.title(withNamespace=False) +- sectionFreeTitle(): replaced by Page.title(withSection=False) +- aslink(): replaced by Page.title(asLink=True) +- encoding(): replaced by Page.site().encoding() + +The following methods of the Page object have been obsoleted and no longer +work (but these methods don't appear to be used anywhere in the code +distributed with the bot framework). The functionality of the two obsolete +methods is easily replaced by using standard search-and-replace techniques. +If you call them, they will print a warning and do nothing else: + +- removeImage() +- replaceImage() + +=== ImagePage objects === + +For ImagePage objects, the getFileMd5Sum() method is deprecated; it is +recommended to replace it with getFileSHA1Sum(), because MediaWiki now +stores the SHA1 hash of images. + +=== Category objects === + +The Category object has been moved from the catlib module to the pywikibot +namespace. Any references to "catlib.Category" can be replaced by +"pywikibot.Category", but the old form is retained for backwards-compatibility. + +For Category objects, the following methods are deprecated: + +- subcategoriesList: use, for example, list(self.subcategories()) instead +- articlesList: use, for example, list(self.articles()) instead +- supercategories: use self.categories() instead +- supercategoriesList: use, for example, list(self.categories()) instead + +# MORE TO COME # Property changes on: branches/rewrite/README-conversion.txt ___________________________________________________________________ Added: svn:mergeinfo + Added: svn:eol-style + native Deleted: branches/rewrite/pywikibot/README-conversion.txt =================================================================== --- branches/rewrite/pywikibot/README-conversion.txt 2009-03-24 02:23:49 UTC (rev 6547) +++ branches/rewrite/pywikibot/README-conversion.txt 2009-03-24 02:48:53 UTC (rev 6548) @@ -1,110 +0,0 @@ -This is a guide to converting bot scripts from version 1 of the -Pywikipediabot framework to version 2. - -Most importantly, note that the version 2 framework *only* supports wikis -using MediaWiki v.1.14 or higher software. If you need to access a wiki that -uses older software, you should continue using version 1 for this purpose. - -The root namespace used in the project has changed from "wikipedia" -to "pywikibot". References to wikipedia need to be changed globally to -pywikibot. Unless noted in this document, other names have not changed; for -example, wikipedia.Page can be replaced by pywikibot.Page throughout any -bot. An effort has been made to design the interface to be as backwards- -compatible as possible, so that in most cases it should be possible to convert -scripts to the new interface simply by changing import statements and doing -global search-and-replace on module names, as discussed in this document. - -With pywikipedia scripts were importing "wikipedia" or "pagegenerators" -libraries; pywikibot is now written as a standard package, and other modules -are contained within it (e.g., pywikibot.site contains Site classes). However, -most commonly-used names are imported into the pywikibot namespace, so that -module names don't need to be used unless specified in the documentation. - -Make sure that the directory that contains the "pywikibot" subdirectory (or -folder) is in sys.path. - -The following changes, at a minimum, need to be made to allow scripts to run: - - change "import wikipedia" to "import pywikibot" - change "import pagegenerators" to "from pywikibot import pagegenerators" - change "import config" to "from pywikibot import config" - change "import catlib" to "from pywikibot import catlib" - change "wikipedia." to "pywikibot." - -wikipedia.setAction() no longer works; you must revise the script to pass an -explicit edit summary message on each put() or put_async() call. - -== Python librairies == - -[Note: the goal will be to package pywikibot with setuptools easy_install, -so that these dependencies will be loaded automatically when the package is -installed, and users won't need to worry about this...] - -To run pywikibot, you will need the httplib2, simplejson, and setuptools -packages-- -* httplib2 : http://code.google.com/p/httplib2/ -* setuptools : http://pypi.python.org/pypi/setuptools/ -* simplejson : http://svn.red-bean.com/bob/simplejson/tags/simplejson-1.7.1/docs/index.html - -or, if you already have setuptools installed, just execute -'easy_install httplib2' and 'easy_install simplejson' - -If you run into errors involving httplib2.urlnorm, update httplib2 to 0.4.0 -(Ubuntu package python-httlib2, for example, is outdated). Note that -httplib2 will run under Python 2.6, but will emit DeprecationWarnings (which -are annoying but don't affect the ability to use the package). - -== Page objects == - -The constructor syntax for Pages has been modified; existing calls in the -format of Page(site, title) will still work, and this is still the preferred -way of creating a Page object from data retrieved from the MediaWiki API -(because the API will have parsed and normalized the title). However, for -titles input by a user or scraped from wikitext, it is preferred to use the -alternative syntax Page(Link(site, wikitext)), where "wikitext" is the -string found between [[ and ]] delimiters. The new Link object (more on -this below) handles link parsing and interpretation that doesn't require -access to the wiki server. - -A third syntax allows easy conversion from a Page object to an ImagePage or -Category, or vice versa: e.g., Category(pageobj) converts a Page to a -Category, as long as the page is in the category namespace. - -The following methods of the Page object have been deprecated (deprecated -methods still work, but print a warning message in debug mode): - -- urlname(): replaced by Page.title(asUrl=True) -- titleWithoutNamespace(): replaced by Page.title(withNamespace=False) -- sectionFreeTitle(): replaced by Page.title(withSection=False) -- aslink(): replaced by Page.title(asLink=True) -- encoding(): replaced by Page.site().encoding() - -The following methods of the Page object have been obsoleted and no longer -work (but these methods don't appear to be used anywhere in the code -distributed with the bot framework). The functionality of the two obsolete -methods is easily replaced by using standard search-and-replace techniques. -If you call them, they will print a warning and do nothing else: - -- removeImage() -- replaceImage() - -=== ImagePage objects === - -For ImagePage objects, the getFileMd5Sum() method is deprecated; it is -recommended to replace it with getFileSHA1Sum(), because MediaWiki now -stores the SHA1 hash of images. - -=== Category objects === - -The Category object has been moved from the catlib module to the pywikibot -namespace. Any references to "catlib.Category" can be replaced by -"pywikibot.Category", but the old form is retained for backwards-compatibility. - -For Category objects, the following methods are deprecated: - -- subcategoriesList: use, for example, list(self.subcategories()) instead -- articlesList: use, for example, list(self.articles()) instead -- supercategories: use self.categories() instead -- supercategoriesList: use, for example, list(self.categories()) instead - -# MORE TO COME # Property changes on: branches/rewrite/scripts ___________________________________________________________________ Added: svn:ignore + *.pyc Added: svn:mergeinfo + Property changes on: branches/rewrite/tests ___________________________________________________________________ Added: svn:ignore + *.pyc Added: svn:mergeinfo +