# OptHub Scorer
OptHub Scorer is a worker program that scores a solution submitted to OptHub.
## Requirements
- Python >=3.6
- Docker >=1.12
See also [requirements.txt](requirements.txt) for dependent python packages.
## Installation
```
$ pip install opthub-scorer
```
## Usage
### How to start a scorer runner
Login the docker registry where the problem image is stored.
```
$ docker login <registry>
```
Start a scorer.
```
$ opthub-scorer
```
Options
|Parameter|Type|Default|Description|
|-|-|-|-|
|url|path|https://opthub-api.herokuapp.com/v1/graphql|URL to OptHub|
|apikey|str||ApiKey|
|interval|int|2|Polling interval|
|verify/no-verify|bool|True|Verify SSL certificate|
|retries|int|3|Retries to establish HTTPS connection|
|timeout|int|600|Timeout to process a query|
|rm|||Remove containers after exit|
|quiet|||Be quieter|
|verbose|||Be more verbose|
|config|path|opthub-scorer.yml|Configuration file|
### How to make a scorer
1. Write an indicator program in your favorite language.
2. Dockerize it.
3. Push the docker image to DockerHub or somewhere else accessible from OptHub.
For this purpose, OptHub hosts its own docker private registry.
4. Register the image tag to OptHub.
See also [example](example/).
## Author
Naoki Hamada (hmkz@s101.xrea.com)
## License
MIT
Raw data
{
"_id": null,
"home_page": "https://github.com/opthub-org/opthub-scorer",
"name": "opthub-scorer",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.6",
"maintainer_email": "",
"keywords": "",
"author": "Naoki Hamada",
"author_email": "hmkz@s101.xrea.com",
"download_url": "https://files.pythonhosted.org/packages/75/79/25d072a68823addfa58422e8d86822a4c5d8b4d834aca8450407fba8845c/opthub-scorer-0.8.1.tar.gz",
"platform": null,
"description": "# OptHub Scorer\nOptHub Scorer is a worker program that scores a solution submitted to OptHub.\n\n## Requirements\n- Python >=3.6\n- Docker >=1.12\n\nSee also [requirements.txt](requirements.txt) for dependent python packages.\n\n## Installation\n```\n$ pip install opthub-scorer\n```\n\n## Usage\n### How to start a scorer runner\nLogin the docker registry where the problem image is stored.\n```\n$ docker login <registry>\n```\n\nStart a scorer.\n```\n$ opthub-scorer\n```\n\nOptions\n|Parameter|Type|Default|Description|\n|-|-|-|-|\n|url|path|https://opthub-api.herokuapp.com/v1/graphql|URL to OptHub|\n|apikey|str||ApiKey|\n|interval|int|2|Polling interval|\n|verify/no-verify|bool|True|Verify SSL certificate|\n|retries|int|3|Retries to establish HTTPS connection|\n|timeout|int|600|Timeout to process a query|\n|rm|||Remove containers after exit|\n|quiet|||Be quieter|\n|verbose|||Be more verbose|\n|config|path|opthub-scorer.yml|Configuration file|\n\n### How to make a scorer\n1. Write an indicator program in your favorite language.\n2. Dockerize it.\n3. Push the docker image to DockerHub or somewhere else accessible from OptHub.\n For this purpose, OptHub hosts its own docker private registry.\n4. Register the image tag to OptHub.\n\nSee also [example](example/).\n\n## Author\nNaoki Hamada (hmkz@s101.xrea.com)\n\n## License\nMIT\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "OptHub Scorer",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/opthub-org/opthub-scorer"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b112d6d102ec685b09cd957bbdf158adf444a4abcadd2946d8c2ddf108ebb0a0",
"md5": "e9544d3cddbf2e64fa1219d650c871ff",
"sha256": "7c2ccfc99bf1fa75eeed686f32753613a7815ededea6b7efb7d393bd1032def7"
},
"downloads": -1,
"filename": "opthub_scorer-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e9544d3cddbf2e64fa1219d650c871ff",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 8654,
"upload_time": "2023-12-15T02:12:02",
"upload_time_iso_8601": "2023-12-15T02:12:02.910356Z",
"url": "https://files.pythonhosted.org/packages/b1/12/d6d102ec685b09cd957bbdf158adf444a4abcadd2946d8c2ddf108ebb0a0/opthub_scorer-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "757925d072a68823addfa58422e8d86822a4c5d8b4d834aca8450407fba8845c",
"md5": "f2be5016bcdd74f286d10a06b16830d5",
"sha256": "ffa78319f2cd876342719f993af1dc2869f4006cb921e2ee2da73c92ceb866fd"
},
"downloads": -1,
"filename": "opthub-scorer-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "f2be5016bcdd74f286d10a06b16830d5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 8259,
"upload_time": "2023-12-15T02:12:04",
"upload_time_iso_8601": "2023-12-15T02:12:04.675563Z",
"url": "https://files.pythonhosted.org/packages/75/79/25d072a68823addfa58422e8d86822a4c5d8b4d834aca8450407fba8845c/opthub-scorer-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 02:12:04",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opthub-org",
"github_project": "opthub-scorer",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "opthub-scorer"
}