[](https://travis-ci.org/wikimedia/ores) [](https://codecov.io/gh/wikimedia/ores)
ORES
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 build && docker-compose up
ores will be accessible through localhost:8080
Running tests
For a native installation, make sure you installed dependencies for testing:
pip install -r test-requirements.txt
then run:
py.test .
For docker installation, run:
docker-compose exec ores-worker py.test /ores
Utilities
ORES provies several utilities: * precached: Starts a daemon that requests scores for revisions as they happen * score_revisions: Scores a set of revisions using an ORES API * stress_test: Scores a large set of revisions at a configurable rate * test_api: Runs a series of tests against a live ORES API
In order to run any of them, run it through ./utility wrapper:
./utility test_api -h
For docker installations run it through one of containers:
docker-compose exec ores-worker /ores/utility test_api -h
4 maintainers
Metadata
4 maintainers
Release files for ores 1.4.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| ores-1.4.0.tar.gz | 121.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| ores-1.4.0-py2.py3-none-any.whl | Python 3, Python 2 | none | any | Details |
Total release size: 282.3 kB
Release files / ores-1.4.0.tar.gz
| Download URL | ores-1.4.0.tar.gz |
|---|---|
| Size | 121.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8c21cf7e3c988790157b49025ff78bc2603c0fac439e1feede4acbcb3fa35612
|
|
BLAKE2b-256 checksum How to use checksums |
1de8adc50a6fc3ed59c615c623af46333a412d6efb53c1a9e500ec5981b192e3
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.15.0 CPython/3.5.9
|
Release files / ores-1.4.0-py2.py3-none-any.whl
| Download URL | ores-1.4.0-py2.py3-none-any.whl |
|---|---|
| Size | 160.7 kB |
| Tags | Python 2 Python 3 |
|
SHA-256 checksum How to use checksums |
9a601cc902181188f6f1b4a629c0f61702e86ddf88759049114342bba384ec52
|
|
BLAKE2b-256 checksum How to use checksums |
ab5738f743dd9c12a7e6ab4df3f260d99027274f7b65fb3c3ad3292cc679f230
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/1.15.0 pkginfo/1.5.0.1 requests/2.23.0 setuptools/45.2.0 requests-toolbelt/0.9.1 tqdm/4.15.0 CPython/3.5.9
|
](https://travis-ci.org/wikimedia/ores){kind=link}
](https://codecov.io/gh/wikimedia/ores){kind=link}