# nlit
<!-- 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 nlit --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install nlit
```
### nbdev
``` sh
# activate conda environment
$ conda activate nlit
# make sure the nlit package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the nlit 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/nlit):
``` sh
$ pip install git+https://github.com/dsm-72/nlit.git
```
or from [conda](https://anaconda.org/dsm-72/nlit)
``` sh
$ conda install -c dsm-72 nlit
```
or from [pypi](https://pypi.org/project/nlit/)
``` sh
$ pip install nlit
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/nlit)
[pages](https://dsm-72.github.io/nlit/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/nlit) and
[pypi](https://pypi.org/project/nlit/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/xnbs",
"name": "xnbs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "xnbs extra extras notebooks nb nbs nbdev utils utilities jupyter",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/b8/26/c87f14a1eb139ac5ce6401da1b49be54e0a736d1ec8c6f20798eda84da59/xnbs-0.0.2.tar.gz",
"platform": null,
"description": "# nlit\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 nlit --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install nlit\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate nlit\n\n# make sure the nlit 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 nlit 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/nlit):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/nlit.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/nlit)\n\n``` sh\n$ conda install -c dsm-72 nlit\n```\n\nor from [pypi](https://pypi.org/project/nlit/)\n\n``` sh\n$ pip install nlit\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/nlit)\n[pages](https://dsm-72.github.io/nlit/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/nlit) and\n[pypi](https://pypi.org/project/nlit/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "xnbs",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/xnbs"
},
"split_keywords": [
"xnbs",
"extra",
"extras",
"notebooks",
"nb",
"nbs",
"nbdev",
"utils",
"utilities",
"jupyter"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dc76d50fe80c98350b494cd6f27a85d18f18f48ff8c0accf7c4232c00ba915ba",
"md5": "786f7c6667fa0175d52af82a77c6260b",
"sha256": "148a703482ff9e9af286872b59fc4c92ffe4607287398bbb859d054cc05b3d69"
},
"downloads": -1,
"filename": "xnbs-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "786f7c6667fa0175d52af82a77c6260b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 7892,
"upload_time": "2023-10-26T18:21:48",
"upload_time_iso_8601": "2023-10-26T18:21:48.419935Z",
"url": "https://files.pythonhosted.org/packages/dc/76/d50fe80c98350b494cd6f27a85d18f18f48ff8c0accf7c4232c00ba915ba/xnbs-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "b826c87f14a1eb139ac5ce6401da1b49be54e0a736d1ec8c6f20798eda84da59",
"md5": "f1f263471bb2682b291902d750f8ffd9",
"sha256": "c15c35429c724bef91596dbcdfe53591384969ac9700323491db019c1dcf046f"
},
"downloads": -1,
"filename": "xnbs-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "f1f263471bb2682b291902d750f8ffd9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8370,
"upload_time": "2023-10-26T18:21:49",
"upload_time_iso_8601": "2023-10-26T18:21:49.804265Z",
"url": "https://files.pythonhosted.org/packages/b8/26/c87f14a1eb139ac5ce6401da1b49be54e0a736d1ec8c6f20798eda84da59/xnbs-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 18:21:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "xnbs",
"github_not_found": true,
"lcname": "xnbs"
}
JSON
