/oabot

Adding links to full text in Wikipedia references

Primary LanguagePythonMIT LicenseMIT

Wikipedia OAbot Build Status

This tool looks for open access versions of references in Wikipedia articles. (For now only the English Wikipedia.)

It relies on the Dissemin API and Unpaywall.

Start editing citations

Report any issues on Phabricator

OAbot requires Python 3 for bot.py due to the pywikibot dependency (which can be ignored if you don't run bot.py). The latest version tested with Python 2 is tagged as python2.

Local installation and usage instructions:

  • Clone the repository on your computer and enter the project directory.
  • Install dependencies with pip install -r requirements.txt.
  • Create a database config with cp dbconfig.py.in dbconfig.py (this database is used to store edit counts)
  • Serve the application with a WSGI-enabled server, using app.py, or run the application locally with python app.py, which serves the tool on http://localhost:5000/.
  • To run the tool in production, set up the config.yaml with the tool's secrets.
  • To run the bot, follow the pywikibot instructions and make sure the user-config.py file with credentials is in one of the relevant directories, for example the working directory of bot.py.