# nbkit
<!-- 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 nbkit --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install nbkit
```
### nbdev
``` sh
# activate conda environment
$ conda activate nbkit
# make sure the nbkit package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the nbkit package
$ nbdev_prepare
```
### Publishing
``` sh
# publish to pypi
$ nbdev_pypi
# publish to conda
$ nbdev_conda --build_args '-c conda-forge'
$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'
```
# Usage
## Installation
Install latest from the GitHub
[repository](https://github.com/dsm-72/nbkit):
``` sh
$ pip install git+https://github.com/dsm-72/nbkit.git
```
or from [conda](https://anaconda.org/dsm-72/nbkit)
``` sh
$ conda install -c dsm-72 nbkit
```
or from [pypi](https://pypi.org/project/nbkit/)
``` sh
$ pip install nbkit
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/nbkit)
[pages](https://dsm-72.github.io/nbkit/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/nbkit) and
[pypi](https://pypi.org/project/nbkit/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/nbkit",
"name": "nbkit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python nbkit",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/cf/0f/fcc082cfbb61dbca3da25683a8353564caea11fe7861bdc13d1ce7b27b10/nbkit-0.0.10.tar.gz",
"platform": null,
"description": "# nbkit\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 nbkit --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install nbkit\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate nbkit\n\n# make sure the nbkit 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 nbkit 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$ nbdev_conda --mambabuild --build_args '-c conda-forge -c dsm-72'\n```\n\n# Usage\n\n## Installation\n\nInstall latest from the GitHub\n[repository](https://github.com/dsm-72/nbkit):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/nbkit.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/nbkit)\n\n``` sh\n$ conda install -c dsm-72 nbkit\n```\n\nor from [pypi](https://pypi.org/project/nbkit/)\n\n``` sh\n$ pip install nbkit\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/nbkit)\n[pages](https://dsm-72.github.io/nbkit/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/nbkit) and\n[pypi](https://pypi.org/project/nbkit/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "jupyter notebook toolkit",
"version": "0.0.10",
"project_urls": {
"Homepage": "https://github.com/dsm-72/nbkit"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"nbkit"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "b9b2bb914bde377d84eb0f73345ab1503e9e9ca22d677cebbabfa1b07d87861a",
"md5": "034fd2af68032696c8cc01dbbeb6d621",
"sha256": "89521089c593cdca06f81ff9286fb74d6276c804b7af110ee08ed9a5614cca72"
},
"downloads": -1,
"filename": "nbkit-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "034fd2af68032696c8cc01dbbeb6d621",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 34973,
"upload_time": "2023-10-26T18:39:02",
"upload_time_iso_8601": "2023-10-26T18:39:02.620776Z",
"url": "https://files.pythonhosted.org/packages/b9/b2/bb914bde377d84eb0f73345ab1503e9e9ca22d677cebbabfa1b07d87861a/nbkit-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cf0ffcc082cfbb61dbca3da25683a8353564caea11fe7861bdc13d1ce7b27b10",
"md5": "d9674462390fdbf908847f0ed44b58e1",
"sha256": "f0235d641be7aa07d3584240fa60ea08c2503da9a8ef5588d3fd3f207633b193"
},
"downloads": -1,
"filename": "nbkit-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "d9674462390fdbf908847f0ed44b58e1",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 26254,
"upload_time": "2023-10-26T18:39:03",
"upload_time_iso_8601": "2023-10-26T18:39:03.932779Z",
"url": "https://files.pythonhosted.org/packages/cf/0f/fcc082cfbb61dbca3da25683a8353564caea11fe7861bdc13d1ce7b27b10/nbkit-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 18:39:03",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "nbkit",
"github_not_found": true,
"lcname": "nbkit"
}
JSON
