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.2.1.tar.gz (113.3 kB view details)

Uploaded Source

Built Distribution

ores-1.2.1-py2.py3-none-any.whl (897.1 kB view details)

Uploaded Python 2 Python 3

File details

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

File metadata

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

File hashes

Hashes for ores-1.2.1.tar.gz
Algorithm Hash digest
SHA256 eb5d0b133e6536e84b362c0aef2fee8e7d91f4f732131796890397501c9b3d30
MD5 4ffc99afb8b196e707050087627dac4d
BLAKE2b-256 fe361ab6aad7e4d25bebc7b352904b0c87a84a2d29cc443a0536cc7506d3e0ca

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for ores-1.2.1-py2.py3-none-any.whl
Algorithm Hash digest
SHA256 543811c605bf8cd662fdb7d7a0e50427088912550ace3cc71cffb0e68731c5ac
MD5 7eb9d9e3798f4a209a93edde0eb8afc2
BLAKE2b-256 ea5043876eb63e4be9a71f1975d0196b57f0a02149182f751afc035d53c5f78d

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