# OptHub Evaluator
OptHub Evaluator is a worker program that evaluates 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-evaluator
```
## Usage
### How to start an evaluator
Login the docker registry where the problem image is stored.
```
$ docker login <registry>
```
Start an evaluator.
```
$ opthub-evaluator
```
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-evaluator.yml|Configuration file|
### How to make an problem image
1. Write a problem 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-evaluator",
"name": "opthub-evaluator",
"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/24/ef/b07caf9df6984133e3b08fab2e9a6599efc14e5f0e61a2213dd82ea16bcc/opthub-evaluator-0.8.1.tar.gz",
"platform": null,
"description": "# OptHub Evaluator\nOptHub Evaluator is a worker program that evaluates 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-evaluator\n```\n\n## Usage\n### How to start an evaluator\nLogin the docker registry where the problem image is stored.\n```\n$ docker login <registry>\n```\n\nStart an evaluator.\n```\n$ opthub-evaluator\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-evaluator.yml|Configuration file|\n\n### How to make an problem image\n1. Write a problem 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 Evaluator",
"version": "0.8.1",
"project_urls": {
"Homepage": "https://github.com/opthub-org/opthub-evaluator"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58f3dc96779e6d9aca621933925807d568506556a3e3bd2270fa5e0bc0126f26",
"md5": "7c0580c586ec90fad299e426060141b4",
"sha256": "188acbe25a878aab0b5ca8b7f738a9ffb98e8a3b11fe1bdeaf6c58250a0cc5c0"
},
"downloads": -1,
"filename": "opthub_evaluator-0.8.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7c0580c586ec90fad299e426060141b4",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.6",
"size": 9233,
"upload_time": "2023-12-15T02:11:00",
"upload_time_iso_8601": "2023-12-15T02:11:00.433494Z",
"url": "https://files.pythonhosted.org/packages/58/f3/dc96779e6d9aca621933925807d568506556a3e3bd2270fa5e0bc0126f26/opthub_evaluator-0.8.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "24efb07caf9df6984133e3b08fab2e9a6599efc14e5f0e61a2213dd82ea16bcc",
"md5": "ce4a8e2366f92a3f3345543518889a70",
"sha256": "f4a099f8e435fbdd9aceca2059e4a0441541e658be28d7de60b2128a135187a6"
},
"downloads": -1,
"filename": "opthub-evaluator-0.8.1.tar.gz",
"has_sig": false,
"md5_digest": "ce4a8e2366f92a3f3345543518889a70",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.6",
"size": 9745,
"upload_time": "2023-12-15T02:11:02",
"upload_time_iso_8601": "2023-12-15T02:11:02.502500Z",
"url": "https://files.pythonhosted.org/packages/24/ef/b07caf9df6984133e3b08fab2e9a6599efc14e5f0e61a2213dd82ea16bcc/opthub-evaluator-0.8.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-15 02:11:02",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "opthub-org",
"github_project": "opthub-evaluator",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"tox": true,
"lcname": "opthub-evaluator"
}
JSON
