Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
wetneb authored Apr 20, 2017
1 parent d0c7169 commit 59cf481
Showing 1 changed file with 3 additions and 14 deletions.
17 changes: 3 additions & 14 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,16 @@
Wikipedia OAbot
===============

This scripts looks for open access versions of references in Wikipedia articles.
If no URL is provided in the citation template, it adds one that points to an open access repository where the reference is available (if we can find one). In the special cases of arXiv or PubMedCentral, it uses the appropriate citation parameters. See the examples below.
This tool looks for open access versions of references in Wikipedia articles.

It relies on the Dissemin API, doai.io, the Zotero translation-server,
and the [CiteSeerX classifiers](https://github.com/SeerLabs/new-csx-extractor).
It relies on the Dissemin API and the Zotero translation-server.

[Try the demo here](https://tools.wmflabs.org/oabot/)
[Start editing citations](https://tools.wmflabs.org/oabot/)
-----------------------------------------------------

Usage:
* Install dependencies with `pip install -r requirements.txt`
* Intall [PDFbox](https://pdfbox.apache.org/) and update its location in
`settings.py`
* Run the script on a Wikipedia article, for instance [Reverse mathematics](http://en.wikipedia.org/wiki/Reverse_mathematics):
`python main.py "Reverse mathematics"`
* This outputs an HTML summary of the proposed changes on the page.
* You can also run it as a web service with `python app.py` (or as a WSGI application)

For instance, here is what you get for the following pages (this takes some time to load as it yiels many API calls):
* [Alan Turing](https://tools.wmflabs.org/oabot/process?name=Alan+Turing)
* [Reverse mathematics](https://tools.wmflabs.org/oabot/process?name=Reverse+mathematics)
* [Pregroup grammar](https://tools.wmflabs.org/oabot/process?name=Pregroup+grammar)
* [Distributional semantics](https://tools.wmflabs.org/oabot/process?name=Distributional+semantics)
* [Deep learning](https://tools.wmflabs.org/oabot/process?name=Deep+learning)

0 comments on commit 59cf481

Please sign in to comment.