# typs
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `typs`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n typs --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install typs
```
### nbdev
``` sh
# activate conda environment
$ conda activate typs
# make sure the typs package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the typs 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/typs):
``` sh
$ pip install git+https://github.com/dsm-72/typs.git
```
or from [conda](https://anaconda.org/dsm-72/typs)
``` sh
$ conda install -c dsm-72 typs
```
or from [pypi](https://pypi.org/project/typs/)
``` sh
$ pip install typs
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/typs)
[pages](https://dsm-72.github.io/typs/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/typs) and
[pypi](https://pypi.org/project/typs/) 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/typs",
"name": "typs",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "protocol prot prots prototype nbdev jupyter notebook python types type alias type typs typ optional opt",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/93/c5/958bac6d392e8d84c89ee7887e7fa966a0e1c6d411982d3c2251d54fb056/typs-0.0.6.tar.gz",
"platform": null,
"description": "# typs\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `typs`\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 typs --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install typs\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate typs\n\n# make sure the typs 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 typs 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/typs):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/typs.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/typs)\n\n``` sh\n$ conda install -c dsm-72 typs\n```\n\nor from [pypi](https://pypi.org/project/typs/)\n\n``` sh\n$ pip install typs\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/typs)\n[pages](https://dsm-72.github.io/typs/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/typs) and\n[pypi](https://pypi.org/project/typs/) 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": "typs (prototype)",
"version": "0.0.6",
"project_urls": {
"Homepage": "https://github.com/dsm-72/typs"
},
"split_keywords": [
"protocol",
"prot",
"prots",
"prototype",
"nbdev",
"jupyter",
"notebook",
"python",
"types",
"type",
"alias",
"type",
"typs",
"typ",
"optional",
"opt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "4d600a4fe667cea131a2d61d9375612343bd6fb8737423c86789d2d2ed08af1a",
"md5": "588af3a02af24942fc5891217b02cb2a",
"sha256": "d9ad42b5f4258e3ea072445ef46e1a191a810da73d986b9e4043239006bee67c"
},
"downloads": -1,
"filename": "typs-0.0.6-py3-none-any.whl",
"has_sig": false,
"md5_digest": "588af3a02af24942fc5891217b02cb2a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 76879,
"upload_time": "2024-03-05T21:38:14",
"upload_time_iso_8601": "2024-03-05T21:38:14.415125Z",
"url": "https://files.pythonhosted.org/packages/4d/60/0a4fe667cea131a2d61d9375612343bd6fb8737423c86789d2d2ed08af1a/typs-0.0.6-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "93c5958bac6d392e8d84c89ee7887e7fa966a0e1c6d411982d3c2251d54fb056",
"md5": "ea7796c19645cfddcb7a6d66b11441cd",
"sha256": "ed6dadce5ccbecfb54609a4781c0ba0e03e12fdfd3f39c8d3123bafdb83a0f4b"
},
"downloads": -1,
"filename": "typs-0.0.6.tar.gz",
"has_sig": false,
"md5_digest": "ea7796c19645cfddcb7a6d66b11441cd",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 66251,
"upload_time": "2024-03-05T21:38:16",
"upload_time_iso_8601": "2024-03-05T21:38:16.075451Z",
"url": "https://files.pythonhosted.org/packages/93/c5/958bac6d392e8d84c89ee7887e7fa966a0e1c6d411982d3c2251d54fb056/typs-0.0.6.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-05 21:38:16",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "typs",
"github_not_found": true,
"lcname": "typs"
}
JSON
