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 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.

Source Distribution

ores-1.3.0.tar.gz (116.2 kB view details)

Uploaded Source

Built Distribution

ores-1.3.0-py2.py3-none-any.whl (901.8 kB view details)

Uploaded Python 2 Python 3

File details

Details for the file ores-1.3.0.tar.gz.

File metadata

  • Download URL: ores-1.3.0.tar.gz
  • Upload date:
  • Size: 116.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.5

File hashes

Hashes for ores-1.3.0.tar.gz
Algorithm Hash digest
SHA256 acf9a63d87b398fbff5d6b2a5cdf33ed62aa72abdeeaef5d08e2113abead9aa9
MD5 f230e10c3f1fbabee47640a8a0671324
BLAKE2b-256 dca3007633ec67e780c7162f4ca094b7611b97e9a5e51897ca3713971b51e425

See more details on using hashes here.

File details

Details for the file ores-1.3.0-py2.py3-none-any.whl.

File metadata

  • Download URL: ores-1.3.0-py2.py3-none-any.whl
  • Upload date:
  • Size: 901.8 kB
  • Tags: Python 2, Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: Python-urllib/3.5

File hashes

Hashes for ores-1.3.0-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 0e46e3d43abbfeb7634f96085a5834e4b383c535e3337d1ec9d43d0aa6c9acdf
MD5 31da3198caf525275fec1b21937c1e61
BLAKE2b-256 1313c937de3859b270bdee281f25fef13eb502514846706b5ce5ebec913a0be4

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page