From c8dfeb17f029d58319b209536672eb831667bedc Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Dan=20Michael=20O=2E=20Hegg=C3=B8?= <danmichaelo@gmail.com> Date: Sun, 12 May 2013 17:54:24 +0200 Subject: [PATCH] remove .txt files --- README.txt | 89 --------------------------------------------- REFERENCE.txt | 91 ----------------------------------------------- RELEASE-NOTES.txt | 69 ----------------------------------- 3 files changed, 249 deletions(-) delete mode 100644 README.txt delete mode 100644 REFERENCE.txt delete mode 100644 RELEASE-NOTES.txt diff --git a/README.txt b/README.txt deleted file mode 100644 index 1aa6753..0000000 --- a/README.txt +++ /dev/null @@ -1,89 +0,0 @@ -This files describes mwclient-0.6.5. The latest version is available in the -subversion repository <https://mwclient.svn.sourceforge.net/svnroot/mwclient> -and also browsable <http://mwclient.svn.sourceforge.net/viewvc/mwclient/>. - -Mwclient is a client to the MediaWiki API <http://mediawiki.org/wiki/API> -and allows access to almost all implemented API functions. Mwclient requires -Python 2.4. This version supports MediaWiki 1.11 and above. However, for -functions not available in the current MediaWiki, a MediaWikiVersionError -is raised. - -This framework is written by Bryan Tong Minh and serves most of his bots. -The framework and this documentation are primarily written for personal -use and may or may not work for you. In case it doesn't, Bryan can be -contacted on btongminh@users.sourceforge.net. - -This framework heavily depends on simplejson, (c) copyright Bob Ippolito. - - -== Implementation notes == -Most properties and generators accept the same parameters as the API, without -their two letter prefix. Exceptions to this rule: -* Image.imageinfo is the imageinfo of the latest image. Earlier versions can be - fetched using imagehistory() -* Site.all* : parameter [ap]from renamed to start -* categorymembers is implemented as Category.members -* deletedrevs is deletedrevisions -* usercontribs is usercontributions -* First parameters of search and usercontributions are search and user - respectively - -Properties and generators are implemented as Python generators. Their limit -parameter is only an indication of the number of items in one chunk. It is not -the total limit. Doing list(generator(limit = limit)) will return ALL items of -generator, and not be limited by the limit value. -Default chunk size is generally the maximum chunk size. - -== HTTPS == -To use https, specify the host as a tuple in the form of ('https', hostname). - -== Example == -## For more information, see REFERENCE.txt -# Init site object -import mwclient -site = mwclient.Site('commons.wikimedia.org') -site.login(username, password) # Optional - -# Edit page -page = site.Pages['Commons:Sandbox'] -text = page.edit() -print 'Text in sandbox:', text.encode('utf-8') -page.save(text + u'\nExtra data', summary = 'Test edit') - -# Printing imageusage -image = site.Images['Example.jpg'] -print 'Image', image.name.encode('utf-8'), 'usage:' -for page in image.imageusage(): - print 'Used:', page.name.encode('utf-8'), '; namespace', page.namespace - print 'Image info:', image.imageinfo - -# Uploading a file -site.upload(open('file.jpg'), 'destination.jpg', 'Image description') - -# Listing all categories (don't do this in reality) -for category in site.allcategories(): - print category - -== License == - Copyright (c) 2006-2011 Bryan Tong Minh - - Permission is hereby granted, free of charge, to any person - obtaining a copy of this software and associated documentation - files (the "Software"), to deal in the Software without - restriction, including without limitation the rights to use, - copy, modify, merge, publish, distribute, sublicense, and/or sell - copies of the Software, and to permit persons to whom the - Software is furnished to do so, subject to the following - conditions: - - The above copyright notice and this permission notice shall be - included in all copies or substantial portions of the Software. - - THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, - EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES - OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND - NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT - HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, - WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING - FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR - OTHER DEALINGS IN THE SOFTWARE. \ No newline at end of file diff --git a/REFERENCE.txt b/REFERENCE.txt deleted file mode 100644 index 1d362d9..0000000 --- a/REFERENCE.txt +++ /dev/null @@ -1,91 +0,0 @@ -This file is intended to be a reference to mwclient. The current version is -mwclient 0.6.6. - -The mwclient framework provides an access to the MediaWiki API. It provides the -functions of the MediaWiki API in a Pythonic manner. - -== Sites == -The 'Site' object is the most important class. It represents a MediaWiki site. -Its constructor accepts various arguments, of which the first two, host and -path are the most important. They represent respectively the hostname without -protocol and the root directory where api.php is located. The path parameter -should end with a slash /. Other protocols than HTTP are currently not -supported. - -site = mwclient.Site(host, path = '/w/', ...) - -=== Pages === -Sites provide access to pages via various generators and the Pages object. The -base Page object is called Page and from that derive Category and Image. When -the page is retrieved via Site.Pages or a generator, it will check -automatically which of those three specific types should be returned. To get -a page by its name, call Site.Pages as a scriptable object: - -page = site.Pages['Template:Stub'] -image = site.Pages['Image:Wiki.png'] # This will return an Image object -image2 = site.Images['Wiki.png'] # The same image - -Alternatively Site.Images and Site.Categories are provided, which do exactly -the same as Site.Pages, except that they require the page name without its -namespace prefixed. - -==== PageProperties ==== -The Page object provides many generators available in the API. In addition to -the page properties listed in the API documentation, also the lists backlinks -and embeddedin are members of the Page object. See for more information about -using generators the section about generators below. - -Category objects provide an extra property members to list all members of the -category. The Category object can also be used itself as an iterator yielding -all its members. - -category = site.Pages['Category:Help'] -for page in category: - print category - -Image objects have additional functions imagehistory and imageusage which -represent the old images and the usage respectively. Image.download returns a -file object to the full size image. - -fr = image.download() -fw = open('Wiki.png', 'rb') -while True: - s = fr.read(4096) - if not s: break - fw.write(s) -fr.close() # Always close those file objects !!! -fw.close() - -==== Editting pages ==== -Call Page.edit() to retrieve the page content. Use Page.save(text, summary = -u'', ...) to save the page. If available, Page.save uses the API to edit, but -falls back to the old way if the write API is not available. - -== Generators == -== Exceptions == - -== Implementation notes == -Most properties and generators accept the same parameters as the API, without -their two letter prefix Exceptions: -* Image.imageinfo is the imageinfo of the latest image. Earlier versions can be - fetched using imagehistory() -* Site.all* : parameter (ap)from renamed to start -* categorymembers is implemented as Category.members -* deletedrevs is deletedrevisions -* usercontribs is usercontributions -* First parameters of search and usercontributions are search and user - respectively - -Properties and generators are implemented as Python generators. Their limit -parameter is only an indication of the number of items in one chunk. It is not -the total limit. Doing list(generator(limit = limit)) will return ALL items of -generator, and not be limitted by the limit value. Use list(generator( -max_items = max_items)) to limit the amount of items returned. -Default chunk size is generally the maximum chunk size. - -== Links == -* SourceForge.net project: http://sourceforge.net/projects/mwclient -* Project website: http://mwclient.sourceforge.net/ -* Subversion: https://mwclient.svn.sourceforge.net/svnroot/mwclient -* Browseable repository: http://mwclient.svn.sourceforge.net/viewvc/mwclient/ -* MediaWiki API documentation: http://mediawiki.org/wiki/API \ No newline at end of file diff --git a/RELEASE-NOTES.txt b/RELEASE-NOTES.txt deleted file mode 100644 index e961256..0000000 --- a/RELEASE-NOTES.txt +++ /dev/null @@ -1,69 +0,0 @@ -RELEASE NOTES FOR MWCLIENT - -This is mwclient 0.6.6. The following are the release notes for this version. - -== Changes in version 0.6.6 == -* Allow setting both the upload description and the page content separately - -== Changes in version 0.6.5 == -* Explicitly convert the Content-Length header to str, avoiding a TypeError - on some versions of Python. -* Fix for upload by URL -* Handle readapidenied error in site init -* Fix version parsing for almost any sane version string - -== Changes in version 0.6.4 == -* Added support for upload API -* Added prop=duplicatefiles -* Properly fix detection of alpha versions -* Added support for builtin json library -* Handle badtoken once -* Bug 2690034: Fix revision iteration -* Fix module conflict with simplejson-1.x by inserting mwclient path at the - beginning of sys.path instead of the end -* Supply token on login if necessary - -== Changes in version 0.6.3 == -* Added domain parameter to login. -* Applied edit fix to page_nowriteapi -* Allow arbitrary data to be passed to page.save -* Fix mwclient on WMF wikis - -== Changes in version 0.6.2 == -Mwclient was released on 2 May 2009. -* Compatibility fixes for MediaWiki 1.13 -* Download fix for images -* Full support for editing pages via write api and split of compatibility to - another file. -* Added expandtemplates api call -* Added and fixed moving via API -* Raise an ApiDisabledError is the API is disabled -* Added support for HTTPS -* Fixed email code -* Mark edits as bots by default. -* Added action=parse. Modified patch by Brian Mingus. -* Improved general HTTP and upload handling. - -== Changes in version 0.6.1 and 0.6.0 == -Mwclient 0.6.1 was released in May 2008. No release notes were kept for -that version. - -Mwclient 0.6.0 was released in February 2008. It was the first official -release via Sourceforge. This version removed some Pywikipedia influences -added in 0.4. - -== Mwclient 0.5 == -Mwclient 0.5 was an architectural redesign which accomplished easy -extendibility and added proper support for continuations. - -== Mwclient 0.4 == -Mwclient 0.4 was somewhat the basis for future releases and shows the current -module architecture. It was influenced by Pywikipedia that was by then -discovered by the author. - -== Mwclient 0.2 and 0.3 == -Mwclient 0.2 and 0.3 were probably a bit of a generalization, and maybe -already used the API for some part, but details are unknown. - -== Mwclient 0.1 == -Mwclient 0.1 was a non-API module for accessing Wikipedia using an XML parser. -- GitLab