collective/wikiq
20
0
Fork 0
Code Issues Pull Requests 3 Activity

convert README to markdown

Browse Source 
Replace the auto-converted README.md (which carried pandoc title-ref
spans and a garbled Tests heading from a malformed rst underline) with
a clean conversion of README.rst, and remove the rst version.
pyproject.toml already declares README.md as the package readme.
Content is unchanged; bringing it up to date is left for a separate
change.

Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
This commit is contained in:
Benjamin Mako Hill
2026-08-06 16:23:52 -07:00
parent 45f0680200
commit fa8adc30ca
2 changed files with 11 additions and 51 deletions
Download Patch File Download Diff File Expand all files Collapse all files

21
README.md
View File

@@ -10,28 +10,29 @@ submodule like:
git submodule update git submodule update
Wikimedia dumps are usually in a compressed format such as 7z (most Wikimedia dumps are usually in a compressed format such as 7z (most
common), gz, or bz2. Wikiq uses your computer\'s compression software to common), gz, or bz2. Wikiq uses your computer's compression software to
read these files. Therefore wikiq depends on [7za]{.title-ref}, read these files. Therefore wikiq depends on `7za`, `gzcat`, and `zcat`.
[gzcat]{.title-ref}, and [zcat]{.title-ref}.
# Dependencies # Dependencies
These non-Python dependencies must be installed on your system for wikiq These non-Python dependencies must be installed on your system for wikiq
and its associated tests to work. and its associated tests to work.
- 7zip - 7zip
- ffmpeg - ffmpeg
A new diff engine based on [\_wikidiff2]{.title-ref} can be used for A new diff engine based on [wikidiff2](https://www.mediawiki.org/wiki/Wikidiff2)
word-persistence. Wikiq can also output the diffs between each page can be used for word-persistence. Wikiq can also output the diffs
revision. This requires installing Wikidiff 2 on your system. On Debian between each page revision. This requires installing Wikidiff 2 on your
or Ubuntu Linux this can be done via. system. On Debian or Ubuntu Linux this can be done via.
`apt-get install php-wikidiff2` `apt-get install php-wikidiff2`
You may have to also run. `sudo phpenmod wikidiff2`. You may have to also run. `sudo phpenmod wikidiff2`.
Tests \-\-\--To run tests: # Tests
To run tests:
python -m unittest test.Wikiq_Unit_Test python -m unittest test.Wikiq_Unit_Test

41
README.rst
View File

@@ -1,41 +0,0 @@
When you install this from git, you will need to first clone the repository::
git clone git://projects.mako.cc/mediawiki_dump_tools
From within the repository working directory, initiatlize and set up the
submodule like::
git submodule init
git submodule update
Wikimedia dumps are usually in a compressed format such as 7z (most common), gz, or bz2. Wikiq uses your computer's compression software to read these files. Therefore wikiq depends on
`7za`, `gzcat`, and `zcat`.
Dependencies
----------------
These non-Python dependencies must be installed on your system for wikiq and its
associated tests to work.
- 7zip
- ffmpeg
A new diff engine based on `_wikidiff2` can be used for word-persistence. Wikiq can also output the diffs between each page revision. This requires installing Wikidiff 2 on your system. On Debian or Ubuntu Linux this can be done via.
``apt-get install php-wikidiff2``
You may have to also run.
``sudo phpenmod wikidiff2``.
Tests
----
To run tests::
python -m unittest test.Wikiq_Unit_Test
TODO:
_______________
1. [] Output metadata about the run. What parameters were used? What versions of deltas?
2. [] Url encoding by default
.. _wikidiff2: https://www.mediawiki.org/wiki/Wikidiff2