# kuut
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n kuut --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install kuut
```
### nbdev
``` sh
# activate conda environment
$ conda activate kuut
# make sure the kuut package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the kuut package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/kuut):
``` sh
$ pip install git+https://github.com/dsm-72/kuut.git
```
or from [conda](https://anaconda.org/dsm-72/kuut)
``` sh
$ conda install -c dsm-72 kuut
```
or from [pypi](https://pypi.org/project/kuut/)
``` sh
$ pip install kuut
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/kuut)
[pages](https://dsm-72.github.io/kuut/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/kuut) and
[pypi](https://pypi.org/project/kuut/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/kuut",
"name": "kuut",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "tqdm kuut progress step stepper interation iter substep notebook interactive",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/dc/c8/483dbe5f7ccc1e6389dd5612fa85d44bdbb7a00b5db527f529d99d563731/kuut-0.0.3.tar.gz",
"platform": null,
"description": "# kuut\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Developer Guide\n\n### Setup\n\n``` sh\n# create conda environment\n$ mamba env create -f env.yml\n\n# update conda environment\n$ mamba env update -n kuut --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install kuut\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate kuut\n\n# make sure the kuut package is installed in development mode\n$ pip install -e .\n\n# make changes under nbs/ directory\n# ...\n\n# compile to have changes apply to the kuut package\n$ nbdev_prepare\n```\n\n### Publishing\n\n``` sh\n# publish to pypi\n$ nbdev_pypi\n\n# publish to conda\n$ nbdev_conda --build_args '-c conda-forge'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/kuut):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/kuut.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/kuut)\n\n``` sh\n$ conda install -c dsm-72 kuut\n```\n\nor from [pypi](https://pypi.org/project/kuut/)\n\n``` sh\n$ pip install kuut\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/kuut)\n[pages](https://dsm-72.github.io/kuut/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/kuut) and\n[pypi](https://pypi.org/project/kuut/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "taqadum: arabic for progress (tqdm). khutuat: arabic for steps (kuut)",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dsm-72/kuut"
},
"split_keywords": [
"tqdm",
"kuut",
"progress",
"step",
"stepper",
"interation",
"iter",
"substep",
"notebook",
"interactive"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5d5fac720d096b85c3f4fbb2537c4e68fcbc80bc51a9fd0e678370b3c7f4c998",
"md5": "44c79874942afd9cd0ee967f062bbcbe",
"sha256": "5b1af5d0b2a732e1642b0e99496bbf56863cf8e204d967357542ea0002598cbf"
},
"downloads": -1,
"filename": "kuut-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "44c79874942afd9cd0ee967f062bbcbe",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9501,
"upload_time": "2023-06-29T16:19:10",
"upload_time_iso_8601": "2023-06-29T16:19:10.836857Z",
"url": "https://files.pythonhosted.org/packages/5d/5f/ac720d096b85c3f4fbb2537c4e68fcbc80bc51a9fd0e678370b3c7f4c998/kuut-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dcc8483dbe5f7ccc1e6389dd5612fa85d44bdbb7a00b5db527f529d99d563731",
"md5": "93cd3790eae084d0acdcee8c567e9878",
"sha256": "407ce7e9da1854a6d60b8fc05c3c265f7c73399b03f05a8212249a67b54b611a"
},
"downloads": -1,
"filename": "kuut-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "93cd3790eae084d0acdcee8c567e9878",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 10194,
"upload_time": "2023-06-29T16:19:12",
"upload_time_iso_8601": "2023-06-29T16:19:12.614302Z",
"url": "https://files.pythonhosted.org/packages/dc/c8/483dbe5f7ccc1e6389dd5612fa85d44bdbb7a00b5db527f529d99d563731/kuut-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-06-29 16:19:12",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "kuut",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "kuut"
}
JSON
