result-reporter

Name	result-reporter JSON
Version	0.2.1 JSON
	download
home_page
Summary	A context manager to report results to and endpoint.
upload_time	2023-08-27 18:29:18
maintainer
docs_url	None
author	Paul Logston
requires_python	>=3.8
license	MIT
keywords
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # Result Reporter Client

This client will report results of a function execution to an endpoint. This
can be especially useful for determining how many students in a class are
successfully completing an exercise.


### Usage

```
import rr

# Define endpoint to send results to.
rr.set_global_endpoint('https://result-reporter.com/ingest')
# User-Assignment identification token. This is provided by Result-Reporter.com
rr.set_global_token('f0c3f-1234-abcd-1234-740e2cf8daf8')


def fibonacci(n: int) -> int:
    # Left for your students to implement.
    pass


# Tests provided for your students.
with rr.Wrap(fibonacci) as f:
    assert f(0) == 0
    assert f(1) == 1
    assert f(2) == 1
    assert f(3) == 2
    assert f(4) == 3
    assert f(5) == 5
    assert f(6) == 8
```

Results will then be available for visualization via the result server.

### Installation

```
$ pip install result-reporter
```

            

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "result-reporter",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": "",
    "keywords": "",
    "author": "Paul Logston",
    "author_email": "paul.logston@gmail.com",
    "download_url": "https://files.pythonhosted.org/packages/60/55/079828f399351a516305d554cb0322898c806102027352212f24c5c8556b/result_reporter-0.2.1.tar.gz",
    "platform": null,
    "description": "# Result Reporter Client\n\nThis client will report results of a function execution to an endpoint. This\ncan be especially useful for determining how many students in a class are\nsuccessfully completing an exercise.\n\n\n### Usage\n\n```\nimport rr\n\n# Define endpoint to send results to.\nrr.set_global_endpoint('https://result-reporter.com/ingest')\n# User-Assignment identification token. This is provided by Result-Reporter.com\nrr.set_global_token('f0c3f-1234-abcd-1234-740e2cf8daf8')\n\n\ndef fibonacci(n: int) -> int:\n    # Left for your students to implement.\n    pass\n\n\n# Tests provided for your students.\nwith rr.Wrap(fibonacci) as f:\n    assert f(0) == 0\n    assert f(1) == 1\n    assert f(2) == 1\n    assert f(3) == 2\n    assert f(4) == 3\n    assert f(5) == 5\n    assert f(6) == 8\n```\n\nResults will then be available for visualization via the result server.\n\n### Installation\n\n```\n$ pip install result-reporter\n```\n",
    "bugtrack_url": null,
    "license": "MIT",
    "summary": "A context manager to report results to and endpoint.",
    "version": "0.2.1",
    "project_urls": null,
    "split_keywords": [],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "4425669bccd9865557f2482e28ede0a54ccad34f7b2d5ffbb4938bdc7f228d00",
                "md5": "7c4720c5ba3a5ab57764ca60eb47164c",
                "sha256": "e7328acaa46c0d69b65e8a2b94fc71b18bfa7865db3cf66c33d288818a690e8e"
            },
            "downloads": -1,
            "filename": "result_reporter-0.2.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "7c4720c5ba3a5ab57764ca60eb47164c",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 3280,
            "upload_time": "2023-08-27T18:29:17",
            "upload_time_iso_8601": "2023-08-27T18:29:17.115775Z",
            "url": "https://files.pythonhosted.org/packages/44/25/669bccd9865557f2482e28ede0a54ccad34f7b2d5ffbb4938bdc7f228d00/result_reporter-0.2.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "6055079828f399351a516305d554cb0322898c806102027352212f24c5c8556b",
                "md5": "4c45683bbf4e13eecd7cc90c30079c72",
                "sha256": "2533731b0d1460dd1d28b4819f51d861530fbe8ae64eb5c0968f205f83f43d57"
            },
            "downloads": -1,
            "filename": "result_reporter-0.2.1.tar.gz",
            "has_sig": false,
            "md5_digest": "4c45683bbf4e13eecd7cc90c30079c72",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2910,
            "upload_time": "2023-08-27T18:29:18",
            "upload_time_iso_8601": "2023-08-27T18:29:18.606700Z",
            "url": "https://files.pythonhosted.org/packages/60/55/079828f399351a516305d554cb0322898c806102027352212f24c5c8556b/result_reporter-0.2.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-08-27 18:29:18",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "result-reporter"
}