Metadata-Version: 2.1
Name: kishu
Version: 0.3.4
Summary: Intelligent Python Checkpointing
Author-email: Yongjoo Park <yongjoo@g.illinois.edu>, Supawit Chockchowwat <supawit2@illinois.edu>, Zhaoheng Li <zl20@illinois.edu>
License: Apache-2.0
Project-URL: repository, https://github.com/illinoisdata/kishu
Keywords: kishu,elastic,dart,python,jupyter,notebook,server,lab,cli,web,gui,extension
Classifier: Framework :: Jupyter
Classifier: Framework :: Jupyter :: JupyterLab
Classifier: Framework :: Jupyter :: JupyterLab :: 4
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Python: >=3.8
Description-Content-Type: text/markdown
Requires-Dist: dataclasses
Requires-Dist: dataclasses-json
Requires-Dist: dill
Requires-Dist: ipykernel
Requires-Dist: ipylab
Requires-Dist: jupyter-ui-poll <=1.0.0
Requires-Dist: loguru
Requires-Dist: nbconvert
Requires-Dist: nbformat
Requires-Dist: networkx
Requires-Dist: psutil
Requires-Dist: requests
Requires-Dist: typing
Requires-Dist: flask
Requires-Dist: rich
Requires-Dist: typer
Requires-Dist: Flask-CORS
Requires-Dist: numpy
Requires-Dist: pandas
Requires-Dist: shortuuid
Requires-Dist: xxhash
Provides-Extra: dev
Requires-Dist: black ; extra == 'dev'
Requires-Dist: flake8 ; extra == 'dev'
Requires-Dist: isort ; extra == 'dev'
Requires-Dist: mypy ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-benchmark ; extra == 'dev'
Requires-Dist: pytest-xdist ; extra == 'dev'
Requires-Dist: matplotlib ; extra == 'dev'
Requires-Dist: numpy ; extra == 'dev'
Requires-Dist: scikit-learn ; extra == 'dev'
Requires-Dist: seaborn ; extra == 'dev'
Requires-Dist: textblob ; extra == 'dev'
Requires-Dist: pandas ; extra == 'dev'
Requires-Dist: pylatexenc ; extra == 'dev'
Requires-Dist: websocket-client ; extra == 'dev'
Requires-Dist: requests ; extra == 'dev'
Requires-Dist: types-requests ; extra == 'dev'
Requires-Dist: jupyter ; extra == 'dev'

# 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
```

## Versioning

See (Semantic Versioning)[https://semver.org] for a guideline on incrementing the version number in `pyproject.toml` and `kishu/__init__.py`.
