# getr
<!-- 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 getr --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install getr
```
### nbdev
``` sh
# activate conda environment
$ conda activate getr
# make sure the getr package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the getr 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/getr):
``` sh
$ pip install git+https://github.com/dsm-72/getr.git
```
or from [conda](https://anaconda.org/dsm-72/getr)
``` sh
$ conda install -c dsm-72 getr
```
or from [pypi](https://pypi.org/project/getr/)
``` sh
$ pip install getr
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/getr)
[pages](https://dsm-72.github.io/getr/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/getr) and
[pypi](https://pypi.org/project/getr/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/getr",
"name": "getr",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "getr is question bool type guard typeguard check getr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/12/3d/6cc3d8a33630d51942584e70695730b40ad8562690f97b15952623660b6a/getr-0.0.10.tar.gz",
"platform": null,
"description": "# getr\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 getr --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install getr\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate getr\n\n# make sure the getr 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 getr 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/getr):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/getr.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/getr)\n\n``` sh\n$ conda install -c dsm-72 getr\n```\n\nor from [pypi](https://pypi.org/project/getr/)\n\n``` sh\n$ pip install getr\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/getr)\n[pages](https://dsm-72.github.io/getr/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/getr) and\n[pypi](https://pypi.org/project/getr/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "getr",
"version": "0.0.10",
"project_urls": {
"Homepage": "https://github.com/dsm-72/getr"
},
"split_keywords": [
"getr",
"is",
"question",
"bool",
"type",
"guard",
"typeguard",
"check",
"getr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f8eafd7e71b021d1f72e67357998b26facda08737a7b330afba0be71508e8695",
"md5": "aa667a6941f3859a1dca391af0a26739",
"sha256": "503a363f046a632d429163a4a44a9b55e3b24bbad56ccdd3a136240957eac510"
},
"downloads": -1,
"filename": "getr-0.0.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa667a6941f3859a1dca391af0a26739",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 12359,
"upload_time": "2023-12-28T13:33:47",
"upload_time_iso_8601": "2023-12-28T13:33:47.617232Z",
"url": "https://files.pythonhosted.org/packages/f8/ea/fd7e71b021d1f72e67357998b26facda08737a7b330afba0be71508e8695/getr-0.0.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "123d6cc3d8a33630d51942584e70695730b40ad8562690f97b15952623660b6a",
"md5": "f117ef7761da5c49d6de2dd892165f7e",
"sha256": "915b1a00bf52ba2a65b2b7b698fb9c3f02877ea30fc2969a7da73ff0a9991921"
},
"downloads": -1,
"filename": "getr-0.0.10.tar.gz",
"has_sig": false,
"md5_digest": "f117ef7761da5c49d6de2dd892165f7e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 12676,
"upload_time": "2023-12-28T13:33:49",
"upload_time_iso_8601": "2023-12-28T13:33:49.256296Z",
"url": "https://files.pythonhosted.org/packages/12/3d/6cc3d8a33630d51942584e70695730b40ad8562690f97b15952623660b6a/getr-0.0.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-12-28 13:33:49",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "getr",
"github_not_found": true,
"lcname": "getr"
}
JSON
