wp2git/README.md

24 lines
731 B
Markdown
Raw Normal View History

2013-08-29 17:16:19 -05:00
wp2git
======
This program allows you to download and convert any Wikipedia article's history to a `git` repository, for easy browsing and blaming.
2013-08-29 17:16:19 -05:00
### Usage
2015-12-26 23:58:59 -06:00
$ wp2git.py [--bare] article_name
2013-08-29 17:16:19 -05:00
2015-12-26 23:58:59 -06:00
`wp2git` will create a directory, in which a new `git` repository will be created.
The repository will contain a single file named `article_name.mw`, along with its entire edit history.
2013-08-29 17:16:19 -05:00
Run `wp2git --help` for more options.
### Requirements
`git` should be accessible from `PATH`.
2013-08-29 17:16:19 -05:00
The [`mwclient` package](http://github.com/mwclient/mwclient) must be installed (use `pip install mwclient`).
2013-08-29 17:29:19 -05:00
### Entirely based on
2013-08-29 17:29:19 -05:00
[CyberShadow's version](http://github.com/CyberShadow/wp2git) written in the D language.