# 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/nlit",
"name": "nlit",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nlit named string literal str literals",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/f5/f8/5820f20e2753b1cfdbd370fd3201732406ebe5926d38e44a074d0b7ea00d/nlit-0.0.95.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": "nlit",
"version": "0.0.95",
"project_urls": {
"Homepage": "https://github.com/dsm-72/nlit"
},
"split_keywords": [
"nlit",
"named",
"string",
"literal",
"str",
"literals"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "58e0acc8a791661cfb1f3a1b601b028778b98b6a5e357020613c69e28a5fb930",
"md5": "c794042ce14668cd33f59cb58d575378",
"sha256": "7906e60ce3d31f1316d3c34d447672f8dcb3a8238733926ebb7e7e9b1ac93c01"
},
"downloads": -1,
"filename": "nlit-0.0.95-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c794042ce14668cd33f59cb58d575378",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 35128,
"upload_time": "2024-03-13T18:36:31",
"upload_time_iso_8601": "2024-03-13T18:36:31.230812Z",
"url": "https://files.pythonhosted.org/packages/58/e0/acc8a791661cfb1f3a1b601b028778b98b6a5e357020613c69e28a5fb930/nlit-0.0.95-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f5f85820f20e2753b1cfdbd370fd3201732406ebe5926d38e44a074d0b7ea00d",
"md5": "37935f1d51e4f34bfa3a7f0f215b2549",
"sha256": "68b9e2008b2d16f22dfc95c93fbfea4329055542a7af492b892776f5e3f1bfc7"
},
"downloads": -1,
"filename": "nlit-0.0.95.tar.gz",
"has_sig": false,
"md5_digest": "37935f1d51e4f34bfa3a7f0f215b2549",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 29624,
"upload_time": "2024-03-13T18:36:34",
"upload_time_iso_8601": "2024-03-13T18:36:34.122331Z",
"url": "https://files.pythonhosted.org/packages/f5/f8/5820f20e2753b1cfdbd370fd3201732406ebe5926d38e44a074d0b7ea00d/nlit-0.0.95.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 18:36:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "nlit",
"github_not_found": true,
"lcname": "nlit"
}
JSON
