Skip to main content

A webserver for hosting scorer models.

Project description

[![Build Status](https://travis-ci.org/wikimedia/ores.svg)](https://travis-ci.org/wikimedia/ores) [![Test coverage](https://codecov.io/gh/wikimedia/ores/branch/master/graph/badge.svg)](https://codecov.io/gh/wikimedia/ores)

Objective Revision Evaluation Service

A webserver for hosting scoring services. For more information, see [the ORES documentation on MediaWiki](https://mediawiki.org/wiki/ORES).

Installation

ORES is based on Python 3. Use pip to install ORES:

pip install ores (or pip3 install ores if your distribution defaults to Python 2)

If you’re running with the default Redis configuration, you’ll need to install a few more optional libraries,

pip install ores[redis]

Then you can easily run a test server by:

ores applications.wsgi

Use the -h argument to view its usage.

ores applications.wsgi -h

Visit these pages to see if your installation works,

http://localhost:8080/ http://localhost:8080/v2/scores/testwiki/revid/641962088?features=true

Running ores using docker composer

As an easy way to run ores for development, download and install [docker-compose](https://docs.docker.com/compose/) and then do:

docker-compose up

ores will be accessible through localhost:8080

Running a development server

We recommend that you set up a python “virtual environment”. We put together [this guide](https://gist.github.com/halfak/9f4830895496af9e9731) to help you get everything set up.

Install requirements AND the test-requirements in order to run the default test server and experiment with different scoring strategies.

  • $ pip install -r requirements.txt
  • $ pip install -r test-requirements.txt

Run a test server as ORES using the ./utility, so local changes are reflected: Use -h to view its usage

  • $ ./utility applications.wsgi

Check if everything is running on http://localhost:8080.

Authors

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for ores, version 1.3.1
Filename, size & hash File type Python version Upload date
ores-1.3.1-py2.py3-none-any.whl (922.4 kB) View hashes Wheel 3.5
ores-1.3.1.tar.gz (121.2 kB) View hashes Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page