# dtyp
<!-- 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 dtyp --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install dtyp
```
### nbdev
``` sh
# activate conda environment
$ conda activate dtyp
# make sure the dtyp package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the dtyp 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/dtyp):
``` sh
$ pip install git+https://github.com/dsm-72/dtyp.git
```
or from [conda](https://anaconda.org/dsm-72/dtyp)
``` sh
$ conda install -c dsm-72 dtyp
```
or from [pypi](https://pypi.org/project/dtyp/)
``` sh
$ pip install dtyp
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/dtyp)
[pages](https://dsm-72.github.io/dtyp/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/dtyp) and
[pypi](https://pypi.org/project/dtyp/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/dtyp",
"name": "dtyp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/f5/92/571d9af35a3b2794dce0563bd061d3023523899ff8d09ddfaf39556a6ed2/dtyp-0.0.35.tar.gz",
"platform": null,
"description": "# dtyp\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 dtyp --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install dtyp\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate dtyp\n\n# make sure the dtyp 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 dtyp 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/dtyp):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/dtyp.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/dtyp)\n\n``` sh\n$ conda install -c dsm-72 dtyp\n```\n\nor from [pypi](https://pypi.org/project/dtyp/)\n\n``` sh\n$ pip install dtyp\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/dtyp)\n[pages](https://dsm-72.github.io/dtyp/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/dtyp) and\n[pypi](https://pypi.org/project/dtyp/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "typed dict utilities",
"version": "0.0.35",
"project_urls": {
"Homepage": "https://github.com/dsm-72/dtyp"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5f244d1cd79b33961e8e9a1a515bde1c17d9c17918d14ef2e35558a5f7609b1f",
"md5": "e0511321c6808d6a309cae4109f620b5",
"sha256": "e9a40c84e0ff5559cc21c8ae18ee14a0a3143057f7b98fa57bc1bf9f42abccbe"
},
"downloads": -1,
"filename": "dtyp-0.0.35-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e0511321c6808d6a309cae4109f620b5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 20335,
"upload_time": "2024-03-21T19:43:08",
"upload_time_iso_8601": "2024-03-21T19:43:08.353803Z",
"url": "https://files.pythonhosted.org/packages/5f/24/4d1cd79b33961e8e9a1a515bde1c17d9c17918d14ef2e35558a5f7609b1f/dtyp-0.0.35-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "f592571d9af35a3b2794dce0563bd061d3023523899ff8d09ddfaf39556a6ed2",
"md5": "7dcedb886ff0e965b21fdbf81f4988ce",
"sha256": "e54e4c09d57891bdd1a8c1deeef395f444ce68081dc7f30f2c7291cf33e85fe9"
},
"downloads": -1,
"filename": "dtyp-0.0.35.tar.gz",
"has_sig": false,
"md5_digest": "7dcedb886ff0e965b21fdbf81f4988ce",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 20122,
"upload_time": "2024-03-21T19:43:10",
"upload_time_iso_8601": "2024-03-21T19:43:10.042369Z",
"url": "https://files.pythonhosted.org/packages/f5/92/571d9af35a3b2794dce0563bd061d3023523899ff8d09ddfaf39556a6ed2/dtyp-0.0.35.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-21 19:43:10",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "dtyp",
"github_not_found": true,
"lcname": "dtyp"
}
JSON
