README.rst

   1 When you install this from git, you will need to first clone the repository::
   2
   3   git clone git://projects.mako.cc/mediawiki_dump_tools
   4
   5 From within the repository working directory, initiatlize and set up the
   6 submodule like::
   7
   8   git submodule init
   9   git submodule update
  10
  11
  12 Wikimedia dumps are usually in a compressed format such as 7z (most common),
  13 gz, or bz2. Wikiq uses your computer's compression software to read these
  14 files. Therefore wikiq depends on `7za`, `gzcat`, and `zcat`.
  15
  16 There are also a series of Python dependencies. You can install these using pip
  17 with a command like:
  18
  19   pip3 install mwbase mwreverts mwxml mwtypes mwcli mwdiffs mwpersistence pandas