# nbic
<!-- 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 nbic --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install nbic
```
### nbdev
``` sh
# activate conda environment
$ conda activate nbic
# make sure the nbic package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the nbic 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/nbic):
``` sh
$ pip install git+https://github.com/dsm-72/nbic.git
```
or from [conda](https://anaconda.org/dsm-72/nbic)
``` sh
$ conda install -c dsm-72 nbic
```
or from [pypi](https://pypi.org/project/nbic/)
``` sh
$ pip install nbic
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/nbic)
[pages](https://dsm-72.github.io/nbic/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/nbic) and
[pypi](https://pypi.org/project/nbic/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/nbic",
"name": "nbic",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python nbic nb nbs magic mgc",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/ef/9e/dafe1122a6e1a85b2631730114c43c230e9e075d270f6068f48999081244/nbic-0.0.1.tar.gz",
"platform": null,
"description": "# nbic\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 nbic --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install nbic\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate nbic\n\n# make sure the nbic 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 nbic 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/nbic):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/nbic.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/nbic)\n\n``` sh\n$ conda install -c dsm-72 nbic\n```\n\nor from [pypi](https://pypi.org/project/nbic/)\n\n``` sh\n$ pip install nbic\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/nbic)\n[pages](https://dsm-72.github.io/nbic/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/nbic) and\n[pypi](https://pypi.org/project/nbic/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "jupyter notebook toolkit",
"version": "0.0.1",
"project_urls": {
"Homepage": "https://github.com/dsm-72/nbic"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"nbic",
"nb",
"nbs",
"magic",
"mgc"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "20dcc1db35c298a9b87fb6f06b2d114f0f081b4a690d578134deb53866b0c195",
"md5": "fd042453a1602bbde0d1ee8492ae4bdd",
"sha256": "70e1e327e20bc0c49bc7970de457e39bf915de8a6258f7b749e090cd78776e3a"
},
"downloads": -1,
"filename": "nbic-0.0.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "fd042453a1602bbde0d1ee8492ae4bdd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8414,
"upload_time": "2023-10-19T20:54:20",
"upload_time_iso_8601": "2023-10-19T20:54:20.019294Z",
"url": "https://files.pythonhosted.org/packages/20/dc/c1db35c298a9b87fb6f06b2d114f0f081b4a690d578134deb53866b0c195/nbic-0.0.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "ef9edafe1122a6e1a85b2631730114c43c230e9e075d270f6068f48999081244",
"md5": "8dbf6fe57a74bacda81676169099a9aa",
"sha256": "c341a7d23c2bb7215e8aa38a7de749d328fae8653aefd0599869438366fe3bc1"
},
"downloads": -1,
"filename": "nbic-0.0.1.tar.gz",
"has_sig": false,
"md5_digest": "8dbf6fe57a74bacda81676169099a9aa",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8608,
"upload_time": "2023-10-19T20:54:22",
"upload_time_iso_8601": "2023-10-19T20:54:22.941589Z",
"url": "https://files.pythonhosted.org/packages/ef/9e/dafe1122a6e1a85b2631730114c43c230e9e075d270f6068f48999081244/nbic-0.0.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-19 20:54:22",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "nbic",
"github_not_found": true,
"lcname": "nbic"
}
JSON
