# ptyp
<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->
## Packages that use `ptyp`
## Developer Guide
### Setup
``` sh
# create conda environment
$ mamba env create -f env.yml
# update conda environment
$ mamba env update -n ptyp --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install ptyp
```
### nbdev
``` sh
# activate conda environment
$ conda activate ptyp
# make sure the ptyp package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the ptyp 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/ptyp):
``` sh
$ pip install git+https://github.com/dsm-72/ptyp.git
```
or from [conda](https://anaconda.org/dsm-72/ptyp)
``` sh
$ conda install -c dsm-72 ptyp
```
or from [pypi](https://pypi.org/project/ptyp/)
``` sh
$ pip install ptyp
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/ptyp)
[pages](https://dsm-72.github.io/ptyp/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/ptyp) and
[pypi](https://pypi.org/project/ptyp/) 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/ptyp",
"name": "ptyp",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "protocol prot prots prototype nbdev jupyter notebook python types type alias type ptyp typ optional opt",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/11/83/f31c7c311e3f137e9e5962fc5ac2536e57c9355180f281ae8a00441bfa7a/ptyp-0.0.19.tar.gz",
"platform": null,
"description": "# ptyp\n\n<!-- WARNING: THIS FILE WAS AUTOGENERATED! DO NOT EDIT! -->\n\n## Packages that use `ptyp`\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 ptyp --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install ptyp\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate ptyp\n\n# make sure the ptyp 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 ptyp 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/ptyp):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/ptyp.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/ptyp)\n\n``` sh\n$ conda install -c dsm-72 ptyp\n```\n\nor from [pypi](https://pypi.org/project/ptyp/)\n\n``` sh\n$ pip install ptyp\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/ptyp)\n[pages](https://dsm-72.github.io/ptyp/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/ptyp) and\n[pypi](https://pypi.org/project/ptyp/) 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": "ptyp (prototype)",
"version": "0.0.19",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ptyp"
},
"split_keywords": [
"protocol",
"prot",
"prots",
"prototype",
"nbdev",
"jupyter",
"notebook",
"python",
"types",
"type",
"alias",
"type",
"ptyp",
"typ",
"optional",
"opt"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "5cfb7430749d55ed6627b8741ab5f0e5718220479b558e804da712cb13cb325e",
"md5": "719ae359b7e9b05ba158c88bad2b4fc5",
"sha256": "8cf0c35c0e5abb91a1d1b7313e02fccd80afd7abfbf63599b775c64bb9956fca"
},
"downloads": -1,
"filename": "ptyp-0.0.19-py3-none-any.whl",
"has_sig": false,
"md5_digest": "719ae359b7e9b05ba158c88bad2b4fc5",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 30181,
"upload_time": "2024-02-04T17:05:14",
"upload_time_iso_8601": "2024-02-04T17:05:14.754391Z",
"url": "https://files.pythonhosted.org/packages/5c/fb/7430749d55ed6627b8741ab5f0e5718220479b558e804da712cb13cb325e/ptyp-0.0.19-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "1183f31c7c311e3f137e9e5962fc5ac2536e57c9355180f281ae8a00441bfa7a",
"md5": "699a321c333c67b5b2abee3bd9dae10c",
"sha256": "a5fc97bda196bcb0d3cc746991ba6a22600593ebc4ab7d72e418ee276abef47c"
},
"downloads": -1,
"filename": "ptyp-0.0.19.tar.gz",
"has_sig": false,
"md5_digest": "699a321c333c67b5b2abee3bd9dae10c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 27311,
"upload_time": "2024-02-04T17:05:17",
"upload_time_iso_8601": "2024-02-04T17:05:17.479879Z",
"url": "https://files.pythonhosted.org/packages/11/83/f31c7c311e3f137e9e5962fc5ac2536e57c9355180f281ae8a00441bfa7a/ptyp-0.0.19.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-02-04 17:05:17",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ptyp",
"github_not_found": true,
"lcname": "ptyp"
}
JSON
