kishu

Name	kishu JSON
Version	0.3.1 JSON
	download
home_page	None
Summary	Intelligent Python Checkpointing
upload_time	2025-02-18 03:31:29
maintainer	None
docs_url	None
author	None
requires_python	>=3.8
license	License not determined
keywords	kishu elastic dart python jupyter notebook server lab cli web gui extension
VCS
bugtrack_url
requirements	No requirements were recorded.
Travis-CI	No Travis.
coveralls test coverage	No coveralls.

            # kishu

Intelligent checkpointing framework for Python-based machine learning and scientific computing.
Under development as part of a research project at the University of Illinois at Urbana-Champaign.

`kishu` contains core Kishu components: a Jupyter instrument and a library of Kishu commands. Main user interface is Kishu's command line interface (CLI): `kishu`.


# Installation

Install from PyPI.
```
pip install kishu
```

## Development

Installing Kishu in the editable mode.

```bash
make install
```

Formatting source code.

```bash
make fmt
```

Linting source code (e.g., definitions, type checking).

```bash
make lint
```

Running all unit tests. It generates a coverage report at `./htmlcov/index.html`.
```bash
make test
```

Running PyTest with benchmarks.
```bash
pytest --run-benchmark
```

# Deployment

The following command will upload this project to pypi (https://pypi.org/project/kishu/).

```
bash upload2pypi.sh
```

            

Raw data

            {
    "_id": null,
    "home_page": null,
    "name": "kishu",
    "maintainer": null,
    "docs_url": null,
    "requires_python": ">=3.8",
    "maintainer_email": null,
    "keywords": "kishu, elastic, dart, python, jupyter, notebook, server, lab, cli, web, gui, extension",
    "author": null,
    "author_email": "Yongjoo Park <yongjoo@g.illinois.edu>, Supawit Chockchowwat <supawit2@illinois.edu>, Zhaoheng Li <zl20@illinois.edu>",
    "download_url": "https://files.pythonhosted.org/packages/af/d6/1c7dab6542eb328b5bed2662cd1f621858a643e3f6af619f87643b57791a/kishu-0.3.1.tar.gz",
    "platform": null,
    "description": "# kishu\n\nIntelligent checkpointing framework for Python-based machine learning and scientific computing.\nUnder development as part of a research project at the University of Illinois at Urbana-Champaign.\n\n`kishu` contains core Kishu components: a Jupyter instrument and a library of Kishu commands. Main user interface is Kishu's command line interface (CLI): `kishu`.\n\n\n# Installation\n\nInstall from PyPI.\n```\npip install kishu\n```\n\n## Development\n\nInstalling Kishu in the editable mode.\n\n```bash\nmake install\n```\n\nFormatting source code.\n\n```bash\nmake fmt\n```\n\nLinting source code (e.g., definitions, type checking).\n\n```bash\nmake lint\n```\n\nRunning all unit tests. It generates a coverage report at `./htmlcov/index.html`.\n```bash\nmake test\n```\n\nRunning PyTest with benchmarks.\n```bash\npytest --run-benchmark\n```\n\n# Deployment\n\nThe following command will upload this project to pypi (https://pypi.org/project/kishu/).\n\n```\nbash upload2pypi.sh\n```\n",
    "bugtrack_url": null,
    "license": "License not determined",
    "summary": "Intelligent Python Checkpointing",
    "version": "0.3.1",
    "project_urls": {
        "repository": "https://github.com/illinoisdata/kishu"
    },
    "split_keywords": [
        "kishu",
        " elastic",
        " dart",
        " python",
        " jupyter",
        " notebook",
        " server",
        " lab",
        " cli",
        " web",
        " gui",
        " extension"
    ],
    "urls": [
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "8bd4836e4826efc1d20aed7edc2d5e8565ef0f61eb6c110a18fabda20dd484b5",
                "md5": "9c7597d0aa3fde8821ff06e0b1b31b9d",
                "sha256": "c2556c6f019fa9e92de185f04f53a4cff4673edc6c928d0546b9cd026f18daec"
            },
            "downloads": -1,
            "filename": "kishu-0.3.1-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "9c7597d0aa3fde8821ff06e0b1b31b9d",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8",
            "size": 69138,
            "upload_time": "2025-02-18T03:31:28",
            "upload_time_iso_8601": "2025-02-18T03:31:28.534182Z",
            "url": "https://files.pythonhosted.org/packages/8b/d4/836e4826efc1d20aed7edc2d5e8565ef0f61eb6c110a18fabda20dd484b5/kishu-0.3.1-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": null,
            "digests": {
                "blake2b_256": "afd61c7dab6542eb328b5bed2662cd1f621858a643e3f6af619f87643b57791a",
                "md5": "6b5fbbac4d43e189ebec972c92847317",
                "sha256": "e6083519256a0e8ed77bba997c5ca932368a08284791d7221163d0d4ae7c7afc"
            },
            "downloads": -1,
            "filename": "kishu-0.3.1.tar.gz",
            "has_sig": false,
            "md5_digest": "6b5fbbac4d43e189ebec972c92847317",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8",
            "size": 2489491,
            "upload_time": "2025-02-18T03:31:29",
            "upload_time_iso_8601": "2025-02-18T03:31:29.818931Z",
            "url": "https://files.pythonhosted.org/packages/af/d6/1c7dab6542eb328b5bed2662cd1f621858a643e3f6af619f87643b57791a/kishu-0.3.1.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2025-02-18 03:31:29",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "illinoisdata",
    "github_project": "kishu",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "kishu"
}