{ "info": { "author": "Boxuan Li", "author_email": "liboxuan@connect.hku.hk", "bugtrack_url": null, "classifiers": [ "License :: OSI Approved :: MIT License", "Operating System :: OS Independent", "Programming Language :: Python :: 2", "Programming Language :: Python :: 2.7", "Programming Language :: Python :: 3", "Programming Language :: Python :: 3.5", "Programming Language :: Python :: 3.6", "Programming Language :: Python :: 3.7" ], "description": "

\n \n \n \n

\n\n

Automated code benchmark solution.

\n

Empower developers with tools to trace and analyze project performances.

\n\n## Introduction\n\n### What is Codebench?\n\nCodebench is a tool that runs user-defined benchmark programs, monitors system\ninformation and generates reports. It is most powerful when using in a project\ntracked by git. It runs benchmarks based on different commits and reports the\nsystem usage difference, so that users can compare and track performance\nchanges of their project across commits. It can also be used in CI (Continuous\nIntegration) to detect recent commits that increases/decreases project\nperformance.\n\n### What Codebench is not?\n\nCodebench itself does not provide benchmark programs. It is not smart\nenough to generate a benchmark program for your code. Instead, it can be\nconsidered as a wrapper or a supervisor for your benchmark.\n\n### Features\n\n- Normal Mode\n - comparison among commits\n - auto-generated report\n- CI Mode (in development)\n - comparison with baseline\n - auto-generated report\n - threshold alarms\n\n## Installation\n\nCodebench can be simply installed by running:\n\n```bash\npip install codebench\n```\n\nIf you want to install from a source distribution,\nextract the tarball and run the following command:\n\n```bash\npython setup.py install\n```\n\n## Usage\n\n### Command Line Interface\n\nCodebench provides a command line interface. Run `codebench -h` for details.\n\n### Sample\n\nSee [codebench-sample](https://github.com/li-boxuan/codebench-sample)\nfor details.\n\nA quick demo is demonstrated below:\n\n```bash\ncodebench --before ./before_script.sh --start ./benchmark.py \\\n--report_type chart --commits cb91b8 3cd96d bb1541\n```\n\n![memory_usage](https://user-images.githubusercontent.com/25746010/49643853-c0dffd80-fa51-11e8-8ffb-95da64347a41.png)\n![elapsed_time](https://user-images.githubusercontent.com/25746010/49643851-c0476700-fa51-11e8-8014-064c666336e7.png)\n![cpu_usage](https://user-images.githubusercontent.com/25746010/49643850-c0476700-fa51-11e8-9d28-5dbe818a3bf3.png)\n\n\n", "description_content_type": "text/markdown", "docs_url": null, "download_url": "", "downloads": { "last_day": -1, "last_month": -1, "last_week": -1 }, "home_page": "https://github.com/li-boxuan/codebench", "keywords": "", "license": "", "maintainer": "", "maintainer_email": "", "name": "codebench", "package_url": "https://pypi.org/project/codebench/", "platform": "", "project_url": "https://pypi.org/project/codebench/", "project_urls": { "Homepage": "https://github.com/li-boxuan/codebench" }, "release_url": "https://pypi.org/project/codebench/0.0.2/", "requires_dist": [ "GitPython", "psutil", "pyecharts" ], "requires_python": "", "summary": "Automated code benchmark solution", "version": "0.0.2" }, "last_serial": 4575523, "releases": { "0.0.2": [ { "comment_text": "", "digests": { "md5": "0e877c60478632aa89546b2bc045415d", "sha256": "55bfda4dc6b06b4ea4b0fdb99a1265af7e304fe99890bd3e731f4672dc50d3ce" }, "downloads": -1, "filename": "codebench-0.0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "0e877c60478632aa89546b2bc045415d", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 8394, "upload_time": "2018-12-08T15:56:37", "url": "https://files.pythonhosted.org/packages/91/ba/185627825142170061eb2db4e92cc1ca0e3d5d3c8582f74c7e18e0b80bda/codebench-0.0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ce7bb1c2031f27d8c89e6c8c4333667", "sha256": "3555cf69f805b03d4cb78a21b551d2223f77ce82187cf98f27d4b8ebc4aca36d" }, "downloads": -1, "filename": "codebench-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4ce7bb1c2031f27d8c89e6c8c4333667", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8395, "upload_time": "2018-12-08T15:56:38", "url": "https://files.pythonhosted.org/packages/d5/83/8375bdf4c71b5110d657428e9798c4b59a9ec4882026a20658772b63475f/codebench-0.0.2-py3-none-any.whl" } ] }, "urls": [ { "comment_text": "", "digests": { "md5": "0e877c60478632aa89546b2bc045415d", "sha256": "55bfda4dc6b06b4ea4b0fdb99a1265af7e304fe99890bd3e731f4672dc50d3ce" }, "downloads": -1, "filename": "codebench-0.0.2-py2-none-any.whl", "has_sig": false, "md5_digest": "0e877c60478632aa89546b2bc045415d", "packagetype": "bdist_wheel", "python_version": "py2", "requires_python": null, "size": 8394, "upload_time": "2018-12-08T15:56:37", "url": "https://files.pythonhosted.org/packages/91/ba/185627825142170061eb2db4e92cc1ca0e3d5d3c8582f74c7e18e0b80bda/codebench-0.0.2-py2-none-any.whl" }, { "comment_text": "", "digests": { "md5": "4ce7bb1c2031f27d8c89e6c8c4333667", "sha256": "3555cf69f805b03d4cb78a21b551d2223f77ce82187cf98f27d4b8ebc4aca36d" }, "downloads": -1, "filename": "codebench-0.0.2-py3-none-any.whl", "has_sig": false, "md5_digest": "4ce7bb1c2031f27d8c89e6c8c4333667", "packagetype": "bdist_wheel", "python_version": "py3", "requires_python": null, "size": 8395, "upload_time": "2018-12-08T15:56:38", "url": "https://files.pythonhosted.org/packages/d5/83/8375bdf4c71b5110d657428e9798c4b59a9ec4882026a20658772b63475f/codebench-0.0.2-py3-none-any.whl" } ] }