wp2txt 0.9.5.1 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2aa3c73ab9202aa22974bbb60dad95f10b8abb434cd923fe5f2f6e917f89ac18
-  data.tar.gz: 790d280ee298ff08c5dde80e355f69a1803b949abe14c81912ec6119f3371d59
+  metadata.gz: a15462742cc2912a4dca9e0e4e42e90af4b8f9e09ea29584da94946d0a563872
+  data.tar.gz: 0c63c91b90883b4ed69199ef569c7bd467aece538bb1de1f8e7d632e710d6964
 SHA512:
-  metadata.gz: 39f16e5df3c22f60ef4c0f3c9fe05c5f9ee0732fa90dd9916dd7bf6ffdc05e991afd67425fa6fdb9661cd206e4e16e0db032c131cb59c9d71b7fd2b668635429
-  data.tar.gz: b7c700c667220e11b39fd25a91c76609d3f2608599223f8525e0c8b4b03e29fd1c9547ec2bf30117ca4d65aa0cb09db15f9841ce4790fbfe73a16bfeb5cebfc3
+  metadata.gz: 22f5c61c0ff6d11cd2c0155ad77940e9b618aea1354826a7b8fc5155289b42daff159be6c48f3f038c8df08753731cad623561cbd8055a10a12ce7feae0566ca
+  data.tar.gz: 9b286a09211576f5a397e3e2e46fefbedbf9e95d200f3393b030ede106c9b543fb800c73d3d958ddc5dccad1ba2a30f0b99700af05eef88b142e90c8603e9699

data/README.md

@@ -1,104 +1,145 @@
-# WP2TXT
+<img src='https://raw.githubusercontent.com/yohasebe/wp2txt/master/image/wp2txt-logo.svg' width="400" />
 
-Wikipedia dump file to text converter that extracts both content and category data
+Text conversion tool to extract content and category data from Wikipedia dump files
 
 ## About
 
-WP2TXT extracts plain text data from a Wikipedia dump file (encoded in XML / compressed with Bzip2), removing all MediaWiki markup and other metadata. It was developed for researchers who want easy access to open-source multilingual corpora, but may be used for other purposes as well.
+WP2TXT extracts plain text data from Wikipedia dump files (encoded in XML / compressed with Bzip2), removing all MediaWiki markup and other metadata.
 
-**UPDATE (July 2022)**: Version 0.9.3 adds a new option `category_only`. When this option is enabled, wp2txt will extract only the title and category information of the article. See output examples below.
+**UPDATE (August 2022)**
 
+1. A new option `--category-only` has been added. When this option is enabled, only the title and category information of the article is extracted.
+2. A new option `--summary-only` has been added. If this option is enabled, only the title and text data from the opening paragraphs of the article (= summary) will be extracted.
+3. The current WP2TXT is *several times faster* than the previous version due to parallel processing of multiple files (the rate of speedup depends on the CPU cores used for processing).
 
-## Features
+## Screenshot
+
+<img src='https://raw.githubusercontent.com/yohasebe/wp2txt/master/image/screenshot.png' width="700" />
+
+- WP2TXT 1.0.0
+- MacBook Pro (2019) 2.3GHz 8Core Intel Core i9
+- enwiki-20220802-pages-articles.xml.bz2 (approx. 20GB)
 
-* Converts Wikipedia dump files in various languages
-* Creates output files of specified size
-* Can specify text elements to be extracted and converted (page titles, section titles, lists, tables)
-* Can extract category information for each article
+In the above environment, the process (decompression, splitting, extraction, and conversion) to obtain the plain text data of the English Wikipedia takes a little over two hours.
+
+## Features
 
+- Converts Wikipedia dump files in various languages
+- Creates output files of specified size
+- Allows specifying ext elements (page titles, section headers, paragraphs, list items) to be extracted
+- Allows extracting category information of the article
+- Allows extracting opening paragraphs of the article
 
 ## Installation
 
     $ gem install wp2txt
 
-## Usage
+## Preparation
+
+First, download the latest Wikipedia dump file for the language of your choice.
+
+    https://dumps.wikimedia.org/xxwiki/latest/xxwiki-latest-pages-articles.xml.bz2
+
+where `xx` is language code such as `en` (English) or `zh` (Chinese). Change it to `ja`, for instance, if you want the latest Japanese Wikipedia dump file.
+
+Alternatively, you can also select Wikipedia dump files created on a specific date from [here](http://dumps.wikimedia.org/backup-index.html). Make sure to download a file named in the following format:
+
+    xxwiki-yyyymmdd-pages-articles.xml.bz2
+
+where `xx` is language code such as `en` (English)" or `ko` (Korean), and  `yyyymmdd` is the date of creation (e.g. `20220801`).
+
+## Basic Usage
+
+Suppose you have a folder with a wikipedia dump file and empty subfolders organized as follows:
+
+```
+.
+├── enwiki-20220801-pages-articles.xml.bz2
+├── /xml
+├── /text
+├── /category
+└── /summary
+```
+
+### Decompress and Split
+
+The following command will decompress the entire wikipedia data and split it into many small (approximately 10 MB) XML files.
+
+    $ wp2txt --no-convert -i ./enwiki-20220801-pages-articles.xml.bz2 -o ./xml
+
+**Note**: The resulting files are not well-formed XML. They contain part of the orignal XML extracted from the Wikipedia dump file, taking care to ensure that the content within the <page> tag is not split into multiple files.
+
+### Extract plain text from MediaWiki XML
+
+    $ wp2txt -i ./xml -o ./text
 
-Obtain a Wikipedia dump file (from [here](http://dumps.wikimedia.org/backup-index.html)) with a file name such as:
 
-> `xxwiki-yyyymmdd-pages-articles.xml.bz2`
+### Extract only category info from MediaWiki XML
 
-where `xx` is language code such as "en (English)" or "ja (Japanese)", and  `yyyymmdd` is the date of creation (e.g. 20220720).
+    $ wp2txt -g -i ./xml -o ./category
 
-### Example 1: Basic
+### Extract opening paragraphs from MediaWiki XML
 
-The following extracts text data, including list items and excluding tables.
+    $ wp2txt -s -i ./xml -o ./summary
 
-    $ wp2txt -i xxwiki-yyyymmdd-pages-articles.xml.bz2 -o /output_dir
+### Extract directly from bz2 compressed file
 
-- [Output example (English)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en.txt)
-- [Output example (Japanese)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja.txt)
+It is possible (though not recommended) to 1) decompress the dump files, 2) split the data into files, and 3) extract the text just one line of command. You can automatically remove all the intermediate XML files with `-x` option.
 
-### Example 2: Title and category information only
+    $ wp2txt -i ./enwiki-20220801-pages-articles.xml.bz2 -o ./text -x
 
-The following will extract only article titles and the categories to which each article belongs:
+## Sample Output
 
-    $ wp2txt --category-only -i xxwiki-yyyymmdd-pages-articles.xml.bz2 -o /output_dir
+Output contains title, category info, paragraphs
 
-Each line of the output data contains the title and the categories of an article:
+    $ wp2txt -i ./input -o /output
 
-> title `TAB` category1`,` category2`,` category3`,` ... 
+- [English Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en.txt)
+- [Japanese Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja.txt)
 
-- [Output example (English)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en_categories.txt)
-- [Output example (Japanese)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja_categories.txt)
+Output containing title and category only
 
-### Example 3: Title, category, and summary text only
+    $ wp2txt -g -i ./input -o /output
 
-The following will extract only article titles, the categories to which each article belongs, and text blocks before the first heading of the article:
+- [English Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en_category.txt)
+- [Japanese Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja_category.txt)
 
-    $ wp2txt --summary-only -i xxwiki-yyyymmdd-pages-articles.xml.bz2 -o /output_dir
+Output containing title, category, and summary
 
-- [Output example (English)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en_summary.txt)
-- [Output example (Japanese)](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja_summary.txt)
+    $ wp2txt -s -i ./input -o /output
 
+- [English Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_en_summary.txt)
+- [Japanese Wikipedia](https://raw.githubusercontent.com/yohasebe/wp2txt/master/data/output_samples/testdata_ja_summary.txt)
 
-## Options
+## Command Line Options
 
 Command line options are as follows:
 
     Usage: wp2txt [options]
     where [options] are:
-               --input-file, -i:   Wikipedia dump file with .bz2 (compressed) or
-                                   .txt (uncompressed) format
-           --output-dir, -o <s>:   Output directory (default: current directory)
-    --convert, --no-convert, -c:   Output in plain text (converting from XML)
-                                   (default: true)
-          --list, --no-list, -l:   Show list items in output (default: true)
-    --heading, --no-heading, -d:   Show section titles in output (default: true)
-        --title, --no-title, -t:   Show page titles in output (default: true)
-                    --table, -a:   Show table source code in output (default: false)
-                   --inline, -n:   leave inline template notations unmodified (default: false)
-                --multiline, -m:   leave multiline template notations unmodified (default: false)
-                      --ref, -r:   leave reference notations in the format (default: false)
-                                   [ref]...[/ref]
-                 --redirect, -e:   Show redirect destination (default: false)
-      --marker, --no-marker, -k:   Show symbols prefixed to list items,
-                                   definitions, etc. (Default: true)
-                 --category, -g:   Show article category information (default: true)
-            --category-only, -y:   Extract only article title and categories (default: false)
-             -s, --summary-only:   Extract only article title, categories, and summary text before first heading
-            --file-size, -f <i>:   Approximate size (in MB) of each output file
-                                   (default: 10)
-          -u, --num-threads=<i>:   Number of threads to be spawned (capped to the number of CPU cores;
-                                   set 99 to spawn max num of threads) (default: 4)
-                  --version, -v:   Print version and exit
-                     --help, -h:   Show this message
+      -i, --input                      Path to compressed file (bz2) or decompressed file (xml), or path to directory containing files of the latter format
+      -o, --output-dir=<s>             Path to output directory
+      -c, --convert, --no-convert      Output in plain text (converting from XML) (default: true)
+      -a, --category, --no-category    Show article category information (default: true)
+      -g, --category-only              Extract only article title and categories
+      -s, --summary-only               Extract only article title, categories, and summary text before first heading
+      -f, --file-size=<i>              Approximate size (in MB) of each output file (default: 10)
+      -n, --num-procs                  Number of proccesses to be run concurrently (default: max num of CPU cores minus two)
+      -x, --del-interfile              Delete intermediate XML files from output dir
+      -t, --title, --no-title          Keep page titles in output (default: true)
+      -d, --heading, --no-heading      Keep section titles in output (default: true)
+      -l, --list                       Keep unprocessed list items in output
+      -r, --ref                        Keep reference notations in the format [ref]...[/ref]
+      -e, --redirect                   Show redirect destination
+      -m, --marker, --no-marker        Show symbols prefixed to list items, definitions, etc. (Default: true)
+      -v, --version                    Print version and exit
+      -h, --help                       Show this message
 
 ## Caveats
 
-* Some data, such as mathematical formulas and computer source code, will not be converted correctly. 
+* Some data, such as mathematical formulas and computer source code, will not be converted correctly.
 * Some text data may not be extracted correctly for various reasons (incorrect matching of begin/end tags, language-specific formatting rules, etc.).
 * The conversion process can take longer than expected. When dealing with a huge data set such as the English Wikipedia on a low-spec environment, it can take several hours or more.
-* WP2TXT, by the nature of its task, requires a lot of machine power and consumes a large amount of memory/storage resources. Therefore, there is a possibility that the process may stop unexpectedly. In the worst case, the process may even freeze without terminating successfully. Please understand this and use at your own risk. 
 
 ## Useful Links
 

data/bin/wp2txt

@@ -11,133 +11,181 @@ DOCDIR = File.join(File.dirname(__FILE__), '..', 'doc')
 require 'wp2txt'
 require 'wp2txt/utils'
 require 'wp2txt/version'
+require 'etc'
 require 'optimist'
+require 'parallel'
+require 'pastel'
+require 'tty-spinner'
 
 include Wp2txt
 
 opts = Optimist::options do
-	version Wp2txt::VERSION
-	banner <<-EOS
+  version Wp2txt::VERSION
+  banner <<-EOS
 WP2TXT extracts plain text data from Wikipedia dump file (encoded in XML/compressed with Bzip2) stripping all the MediaWiki markups and other metadata.
 
 Usage: wp2txt [options]
 where [options] are:
 EOS
 
-  opt :input_file,  "Wikipedia dump file with .bz2 (compressed) or .txt (uncompressed) format", :required => true
-  opt :output_dir,  "Output directory", :default => Dir::pwd, :type => String
-  opt :convert,     "Output in plain text (converting from XML)", :default => true
-  opt :list,    "Show list items in output", :default => false 
-  opt :heading, "Show section titles in output", :default => true, :short => "-d"
-  opt :title,   "Show page titles in output", :default => true
-  opt :table,   "Show table source code in output", :default => false
-  opt :inline, "leave inline template notations as they are", :default => false
-  opt :multiline, "leave multiline template notations as they are", :default => false
-  opt :ref, "leave reference notations in the format [ref]...[/ref]", :default => false
-  opt :redirect, "Show redirect destination", :default => false
-  opt :marker, "Show symbols prefixed to list items, definitions, etc.", :default => true
-  opt :category, "Show article category information", :default => true 
-  opt :category_only, "Extract only article title and categories", :default => false
-  opt :summary_only, "Extract only article title, categories, and summary text before first heading", :default => false
-  opt :file_size,   "Approximate size (in MB) of each output file", :default => 10
-  opt :num_threads,   "Number of threads to be spawned (capped to the number of CPU cores; set 99 to spawn max num of threads)", :default => 4
+  opt :input,  "Path to compressed file (bz2) or decompressed file (xml), or path to directory containing files of the latter format", :required => true, :short => "-i"
+  opt :output_dir,  "Path to output directory", :default => Dir::pwd, :type => String, :short => "-o"
+  opt :convert,     "Output in plain text (converting from XML)", :default => true, :short => "-c"
+  opt :category, "Show article category information", :default => true, :short => "-a"
+  opt :category_only, "Extract only article title and categories", :default => false, :short => "-g"
+  opt :summary_only, "Extract only article title, categories, and summary text before first heading", :default => false, :short => "-s"
+  opt :file_size,   "Approximate size (in MB) of each output file", :default => 10, :short => "-f"
+  opt :num_procs,   "Number of proccesses to be run concurrently (default: max num of CPU cores minus two)", :short => "-n"
+  opt :del_interfile,   "Delete intermediate XML files from output dir", :short => "-x", :default => false
+  opt :title,   "Keep page titles in output", :default => true, :short => "-t"
+  opt :heading, "Keep section titles in output", :default => true, :short => "-d"
+  opt :list,    "Keep unprocessed list items in output", :default => false, :short => "-l"
+  opt :ref, "Keep reference notations in the format [ref]...[/ref]", :default => false, :short => "-r"
+  opt :redirect, "Show redirect destination", :default => false, :short => "-e"
+  opt :marker, "Show symbols prefixed to list items, definitions, etc.", :default => true, :short => "-m"
 end
+
 Optimist::die :size, "must be larger than 0" unless opts[:file_size] >= 0
 Optimist::die :output_dir, "must exist" unless File.exist?(opts[:output_dir])
 
+pastel = Pastel.new
+
 input_file = ARGV[0]
 output_dir = opts[:output_dir]
 tfile_size = opts[:file_size]
-num_threads = opts[:num_threads]
+num_processors = Etc.nprocessors
+if opts[:num_procs] && opts[:num_procs].to_i <= num_processors
+  num_processes = opts[:num_procs]
+else
+  num_processes = num_processors - 2
+end
+num_processes = 1 if num_processes < 1
+
 convert = opts[:convert]
 strip_tmarker = opts[:marker] ? false : true
-opt_array = [:title, :list, :heading, :table, :redirect, :multiline, :category, :category_only, :summary_only]
+opt_array = [:title,
+             :list,
+             :heading,
+             :table,
+             :redirect,
+             :multiline,
+             :category,
+             :category_only,
+             :summary_only,
+             :del_interfile]
+
 $leave_inline_template = true if opts[:inline]
 $leave_ref = true if opts[:ref]
+
 config = {}
 opt_array.each do |opt|
   config[opt] = opts[opt]
 end
 
-parent = Wp2txt::CmdProgbar.new
-wpconv = Wp2txt::Runner.new(parent, input_file, output_dir, tfile_size, num_threads, convert, strip_tmarker)
-
-wpconv.extract_text do |article|
-  format_wiki!(article.title)
-
-  if config[:category_only]
-    title = "#{article.title}\t"
-    contents = article.categories.join(", ")
-    contents << "\n"
-  elsif config[:category] && !article.categories.empty?
-    title = "\n[[#{article.title}]]\n\n"
-    contents = "\nCATEGORIES: "
-    contents << article.categories.join(", ")
-    contents << "\n\n"
-  else
-    title = "\n[[#{article.title}]]\n\n"
-    contents = ""
-  end
+if File::ftype(input_file) == "directory"
+  input_files = Dir.glob("#{input_file}/*.xml")
+else
+  puts ""
+  puts pastel.green.bold("Preprocessing")
+  puts "Decompressing and splitting the original dump file."
+  puts pastel.underline("This may take a while. Please be patient!")
 
-  unless config[:category_only]
-    article.elements.each do |e|
-      case e.first
-      when :mw_heading
-        break if config[:summary_only]
-        next if !config[:heading]
-        format_wiki!(e.last)
-        line = e.last
-        line << "+HEADING+" if $DEBUG_MODE
-      when :mw_paragraph
-        format_wiki!(e.last)
-        line = e.last + "\n"
-        line << "+PARAGRAPH+" if $DEBUG_MODE
-      when :mw_table, :mw_htable
-        next if !config[:table]
-        line = e.last
-        line << "+TABLE+" if $DEBUG_MODE
-      when :mw_pre
-        next if !config[:pre]
-        line = e.last
-        line << "+PRE+" if $DEBUG_MODE
-      when :mw_quote
-        line = e.last
-        line << "+QUOTE+" if $DEBUG_MODE
-      when :mw_unordered, :mw_ordered, :mw_definition
-        next if !config[:list]
-        line = e.last
-        line << "+LIST+" if $DEBUG_MODE
-      when :mw_ml_template
-        next if !config[:multiline]
-        line = e.last
-        line << "+MLTEMPLATE+" if $DEBUG_MODE
-      when :mw_redirect
-        next if !config[:redirect]
-        line = e.last
-        line << "+REDIRECT+" if $DEBUG_MODE
-        line << "\n\n"
-      when :mw_isolated_template
-        next if !config[:multiline]
-        line = e.last
-        line << "+ISOLATED_TEMPLATE+" if $DEBUG_MODE
-      when :mw_isolated_tag
-        next
-      else
-        if $DEBUG_MODE
-          # format_wiki!(e.last)
+  spinner = TTY::Spinner.new(":spinner", format: :arrow_pulse, hide_cursor: true, interval: 5)
+  spinner.auto_spin
+  wpsplitter = Wp2txt::Splitter.new(input_file, output_dir, tfile_size)
+  wpsplitter.split_file
+  spinner.stop(pastel.blue.bold("Done!")) # Stop animation
+  exit if !convert
+  input_files = Dir.glob("#{output_dir}/*.xml")
+end
+
+puts ""
+puts pastel.red.bold("Converting")
+puts "Number of files being processed: " + pastel.bold("#{input_files.size}")
+puts "Number of CPU cores being used:  " + pastel.bold("#{num_processes}")
+
+Parallel.map(input_files, progress: pastel.magenta.bold("WP2TXT"), in_processes: num_processes) do |input_file|
+  wpconv = Wp2txt::Runner.new(input_file, output_dir, strip_tmarker, config[:del_interfile])
+  wpconv.extract_text do |article|
+    format_wiki!(article.title)
+
+    if config[:category_only]
+      title = "#{article.title}\t"
+      contents = article.categories.join(", ")
+      contents << "\n"
+    elsif config[:category] && !article.categories.empty?
+      title = "\n[[#{article.title}]]\n\n"
+      contents = "\nCATEGORIES: "
+      contents << article.categories.join(", ")
+      contents << "\n\n"
+    else
+      title = "\n[[#{article.title}]]\n\n"
+      contents = ""
+    end
+
+    unless config[:category_only]
+      article.elements.each do |e|
+        case e.first
+        when :mw_heading
+          break if config[:summary_only]
+          next if !config[:heading]
+          format_wiki!(e.last)
           line = e.last
-          line << "+OTHER+"
-        else
+          line << "+HEADING+" if $DEBUG_MODE
+        when :mw_paragraph
+          format_wiki!(e.last)
+          line = e.last + "\n"
+          line << "+PARAGRAPH+" if $DEBUG_MODE
+        when :mw_table, :mw_htable
+          next if !config[:table]
+          line = e.last
+          line << "+TABLE+" if $DEBUG_MODE
+        when :mw_pre
+          next if !config[:pre]
+          line = e.last
+          line << "+PRE+" if $DEBUG_MODE
+        when :mw_quote
+          line = e.last
+          line << "+QUOTE+" if $DEBUG_MODE
+        when :mw_unordered, :mw_ordered, :mw_definition
+          next if !config[:list]
+          line = e.last
+          line << "+LIST+" if $DEBUG_MODE
+        when :mw_ml_template
+          next if !config[:multiline]
+          line = e.last
+          line << "+MLTEMPLATE+" if $DEBUG_MODE
+        when :mw_redirect
+          next if !config[:redirect]
+          line = e.last
+          line << "+REDIRECT+" if $DEBUG_MODE
+          line << "\n\n"
+        when :mw_isolated_template
+          next if !config[:multiline]
+          line = e.last
+          line << "+ISOLATED_TEMPLATE+" if $DEBUG_MODE
+        when :mw_isolated_tag
           next
+        else
+          if $DEBUG_MODE
+            # format_wiki!(e.last)
+            line = e.last
+            line << "+OTHER+"
+          else
+            next
+          end
         end
+        contents << line << "\n"
       end
-      contents << line << "\n"
     end
-  end
-    
-  if /\A[\s　]*\z/m =~ contents
-    result = ""
-  else
-    result = config[:title] ? title << contents : contents
+
+    if /\A[\s　]*\z/m =~ contents
+      result = ""
+    else
+      result = config[:title] ? title << contents : contents
+    end
   end
 end
+
+puts pastel.blue.bold("Complete!")
+