# atyp
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `atyp`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n atyp --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install atyp
```
### nbdev
``` sh
# activate conda environment
$ conda activate atyp
# make sure the atyp package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the atyp 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/atyp):
``` sh
$ pip install git+https://github.com/dsm-72/atyp.git
```
or from [conda](https://anaconda.org/dsm-72/atyp)
``` sh
$ conda install -c dsm-72 atyp
```
or from [pypi](https://pypi.org/project/atyp/)
``` sh
$ pip install atyp
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/atyp)
[pages](https://dsm-72.github.io/atyp/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/atyp) and
[pypi](https://pypi.org/project/atyp/) 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/atyp",
"name": "atyp",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "nbdev jupyter notebook python types type alias type atyp typ optional opt",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/35/17/970a3022b69fbf246489c50c0d71e1fc0778b7921c3dafbd76944ff9c179/atyp-0.0.62.tar.gz",
"platform": null,
"description": "# atyp\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `atyp`\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 atyp --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install atyp\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate atyp\n\n# make sure the atyp 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 atyp 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/atyp):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/atyp.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/atyp)\n\n``` sh\n$ conda install -c dsm-72 atyp\n```\n\nor from [pypi](https://pypi.org/project/atyp/)\n\n``` sh\n$ pip install atyp\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/atyp)\n[pages](https://dsm-72.github.io/atyp/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/atyp) and\n[pypi](https://pypi.org/project/atyp/) 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": "atyp (type alias)",
"version": "0.0.62",
"project_urls": {
"Homepage": "https://github.com/dsm-72/atyp"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"types",
"type",
"alias",
"type",
"atyp",
"typ",
"optional",
"opt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bb2c0a67b831b5f2594cec5f683e8b7a11e25d909e18974b19b6404925994214",
"md5": "f456735572e172c30e658a77ee234509",
"sha256": "ab2fb36b676b1ac9909da35a1630d566a5227fae8f4e7262590d3334a3b63c07"
},
"downloads": -1,
"filename": "atyp-0.0.62-py3-none-any.whl",
"has_sig": false,
"md5_digest": "f456735572e172c30e658a77ee234509",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 35369,
"upload_time": "2024-04-04T20:11:58",
"upload_time_iso_8601": "2024-04-04T20:11:58.713481Z",
"url": "https://files.pythonhosted.org/packages/bb/2c/0a67b831b5f2594cec5f683e8b7a11e25d909e18974b19b6404925994214/atyp-0.0.62-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3517970a3022b69fbf246489c50c0d71e1fc0778b7921c3dafbd76944ff9c179",
"md5": "4969c006d165d9a91e3bcf6dc00d685b",
"sha256": "8130864457948aa568981d5d6be42228e1bade0ff227156ca21511bf6d3b3d10"
},
"downloads": -1,
"filename": "atyp-0.0.62.tar.gz",
"has_sig": false,
"md5_digest": "4969c006d165d9a91e3bcf6dc00d685b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 26652,
"upload_time": "2024-04-04T20:12:00",
"upload_time_iso_8601": "2024-04-04T20:12:00.771478Z",
"url": "https://files.pythonhosted.org/packages/35/17/970a3022b69fbf246489c50c0d71e1fc0778b7921c3dafbd76944ff9c179/atyp-0.0.62.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-04 20:12:00",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "atyp",
"github_not_found": true,
"lcname": "atyp"
}
JSON
