jcarr
/
wp2git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README.md

This commit is contained in:
Daniel Lenski 2020-12-21 15:27:24 -08:00
parent d64cdd6b19
commit 8d8fdc27fb
1 changed files with 23 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

33
README.md
View File

@ -1,27 +1,40 @@
wp2git
======
This program allows you to download and convert any Wikipedia article's history to a `git` repository, for easy browsing and blaming.
This program allows you to download and convert any Wikipedia article's history to a `git` repository, for easy browsing, [annotation](https://git-scm.com/docs/git-annotate),
and [bisecting](https://git-scm.com/docs/git-annotate) (etc.) of older revisions.
### Requirements
Requires Python 3.x and `git` accessible in your `PATH`, and the [`mwclient` package](https://github.com/mwclient/mwclient)
(which will be auto-installed by `pip`).
### Quick installation
For the latest release, install with:
```
pip install https://github.com/dlenski/wp2git/archive/v1.0.1.zip
pip3 install https://github.com/dlenski/wp2git/archive/v2.0.zip
```
For the latest development build, install with
```
pip3 install https://github.com/dlenski/wp2git/archive/master.zip
```
### Usage
$ wp2git [--bare] article_name
```
$ wp2git [--lang XY] article_name
```
`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.
The repository will contain a single file named `article_name.mw`, along with the entire edit history
of that article on `XY.wikipedia.org`. (If unspecified, the default language is guessed according to
your locale.)
Run `wp2git --help` for more options.
### Requirements
`git` should be accessible from `PATH`. The [`mwclient` package](https://github.com/mwclient/mwclient)
is required.
Use `wp2git --help` to show more options.
### Entirely based on