# ntyp
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `ntyp`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n ntyp --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install ntyp
```
### nbdev
``` sh
# activate conda environment
$ conda activate ntyp
# make sure the ntyp package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the ntyp 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/ntyp):
``` sh
$ pip install git+https://github.com/dsm-72/ntyp.git
```
or from [conda](https://anaconda.org/dsm-72/ntyp)
``` sh
$ conda install -c dsm-72 ntyp
```
or from [pypi](https://pypi.org/project/ntyp/)
``` sh
$ pip install ntyp
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/ntyp)
[pages](https://dsm-72.github.io/ntyp/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/ntyp) and
[pypi](https://pypi.org/project/ntyp/) respectively.
### A = Alias
### C = ClassVar
### Q = Optional
### E = (Over)-Engineered
### Z = Custom
### R = Rich
### P = Plot
### D = Data
### B = Bio
### M = Machine Learning
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/ntyp",
"name": "ntyp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python types type alias type ntyp typ optional opt",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/a3/ed/0cd94b5189294bd999bbcf68c2caf00c27d31bd17d855fd22e2c08210b38/ntyp-0.0.2.tar.gz",
"platform": null,
"description": "# ntyp\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `ntyp`\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 ntyp --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install ntyp\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate ntyp\n\n# make sure the ntyp 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 ntyp 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/ntyp):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/ntyp.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/ntyp)\n\n``` sh\n$ conda install -c dsm-72 ntyp\n```\n\nor from [pypi](https://pypi.org/project/ntyp/)\n\n``` sh\n$ pip install ntyp\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/ntyp)\n[pages](https://dsm-72.github.io/ntyp/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/ntyp) and\n[pypi](https://pypi.org/project/ntyp/) respectively.\n\n### A = Alias\n\n### C = ClassVar\n\n### Q = Optional\n\n### E = (Over)-Engineered\n\n### Z = Custom\n\n### R = Rich\n\n### P = Plot\n\n### D = Data\n\n### B = Bio\n\n### M = Machine Learning\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ntyp (type alias)",
"version": "0.0.2",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ntyp"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"types",
"type",
"alias",
"type",
"ntyp",
"typ",
"optional",
"opt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "e44ab0e37e92d3505473f83341f9caa4d3743b4d42d597322d04f32ec0a75aac",
"md5": "4bfb08637d1704097b6e31cf60113b94",
"sha256": "fbc50840e7697a09f4cfbbc449cd0ba8f0e5d91edf134758a8a6caa7f42ea910"
},
"downloads": -1,
"filename": "ntyp-0.0.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4bfb08637d1704097b6e31cf60113b94",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 9891,
"upload_time": "2023-11-18T17:49:46",
"upload_time_iso_8601": "2023-11-18T17:49:46.403367Z",
"url": "https://files.pythonhosted.org/packages/e4/4a/b0e37e92d3505473f83341f9caa4d3743b4d42d597322d04f32ec0a75aac/ntyp-0.0.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a3ed0cd94b5189294bd999bbcf68c2caf00c27d31bd17d855fd22e2c08210b38",
"md5": "9a97a0d03a71f6bb230a9024981da44f",
"sha256": "50d25e64ace002cbad3918848f705865cdfa25935194e663688c52b2bdc01af7"
},
"downloads": -1,
"filename": "ntyp-0.0.2.tar.gz",
"has_sig": false,
"md5_digest": "9a97a0d03a71f6bb230a9024981da44f",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10183,
"upload_time": "2023-11-18T17:49:47",
"upload_time_iso_8601": "2023-11-18T17:49:47.840824Z",
"url": "https://files.pythonhosted.org/packages/a3/ed/0cd94b5189294bd999bbcf68c2caf00c27d31bd17d855fd22e2c08210b38/ntyp-0.0.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-18 17:49:47",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ntyp",
"github_not_found": true,
"lcname": "ntyp"
}
JSON
