README
1MediaWiki-API
2
3This module provides an interface between perl and the MediaWiki API
4(https://www.mediawiki.org/wiki/API) allowing creation of scripts to automate
5editing and extraction of data from MediaWiki driven sites like Wikipedia.
6
7The latest source/development version is available at
8https://github.com/joolswills/mediawikiapi
9
10STANDARD INSTALLATION
11
12This module requires the following perl modules
13
14 LWP::UserAgent
15 URI::Escape
16 JSON
17 Encode
18 Carp
19
20and optionally JSON::XS for faster JSON decoding.
21
22To install this module, run the following commands:
23
24 perl Makefile.PL
25 make
26 make test
27 make install
28
29Note: make test will make some edits on https://testwiki.exotica.org.uk/wiki/Main_Page
30to check that it is working correctly. This will leave some data (including ip address)
31on the wiki (which is cleaned regularly). If you do not want this, please skip the
32"make test".
33
34CREATING DEBIAN PACKAGE / INSTALLING ON DEBIAN
35
36Please note that Debian squeeze and Ubuntu Karmic already have a package
37with this module.
38
39Note that this module requires the packages libwww-perl, libjson-perl, and
40optionally libjson-xs-perl for faster JSON decoding.
41
42On a debian system, you can easily generate a debian package to install. To
43do this make sure you have the package "dh-make-perl" installed. Unpack the
44MediaWiki-API-x.xx.tar.gz and run
45
46dh-make-perl
47dpkg-buildpackage
48
49If everything works successfully you should have a deb file created in the
50parent folder.
51
52SUPPORT AND DOCUMENTATION
53
54After installing, you can find documentation for this module with the
55perldoc command.
56
57 perldoc MediaWiki::API
58
59You can also look for information at:
60
61 RT, CPAN's request tracker
62 http://rt.cpan.org/NoAuth/Bugs.html?Dist=MediaWiki-API
63
64 AnnoCPAN, Annotated CPAN documentation
65 http://annocpan.org/dist/MediaWiki-API
66
67 CPAN Ratings
68 http://cpanratings.perl.org/d/MediaWiki-API
69
70 Search CPAN
71 http://search.cpan.org/dist/MediaWiki-API
72
73COPYRIGHT AND LICENCE
74
75Copyright (C) 2009 - 2014 Jools Wills
76
77This program is free software: you can redistribute it and/or modify
78it under the terms of the GNU General Public License as published by
79the Free Software Foundation, either version 3 of the License, or
80(at your option) any later version.
81
82This program is distributed in the hope that it will be useful,
83but WITHOUT ANY WARRANTY; without even the implied warranty of
84MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
85GNU General Public License for more details.
86
87You should have received a copy of the GNU General Public License
88along with this program. If not, see <http://www.gnu.org/licenses/>.
89
90