# chck
<!-- 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 chck --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install chck
```
### nbdev
``` sh
# activate conda environment
$ conda activate chck
# make sure the chck package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the chck 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/chck):
``` sh
$ pip install git+https://github.com/dsm-72/chck.git
```
or from [conda](https://anaconda.org/dsm-72/chck)
``` sh
$ conda install -c dsm-72 chck
```
or from [pypi](https://pypi.org/project/chck/)
``` sh
$ pip install chck
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/chck)
[pages](https://dsm-72.github.io/chck/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/chck) and
[pypi](https://pypi.org/project/chck/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/chck",
"name": "chck",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "chck is question bool type guard typeguard check chck",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/d0/eb/58ee049c9eb8991affbc122a972c377b1aa44020bd2dac5c2d32330608a6/chck-0.0.75.tar.gz",
"platform": null,
"description": "# chck\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 chck --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install chck\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate chck\n\n# make sure the chck 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 chck 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/chck):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/chck.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/chck)\n\n``` sh\n$ conda install -c dsm-72 chck\n```\n\nor from [pypi](https://pypi.org/project/chck/)\n\n``` sh\n$ pip install chck\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/chck)\n[pages](https://dsm-72.github.io/chck/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/chck) and\n[pypi](https://pypi.org/project/chck/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "chck",
"version": "0.0.75",
"project_urls": {
"Homepage": "https://github.com/dsm-72/chck"
},
"split_keywords": [
"chck",
"is",
"question",
"bool",
"type",
"guard",
"typeguard",
"check",
"chck"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "042c73e6afface38fbc8f30a8c39adee2aae9a974bf1b14f581b065ff4dd0948",
"md5": "520bf85304995de154272108c3c4937e",
"sha256": "b4d3cf8b07fff75b6dffe160d5f7990acbe37de674104d02571e254365beff3d"
},
"downloads": -1,
"filename": "chck-0.0.75-py3-none-any.whl",
"has_sig": false,
"md5_digest": "520bf85304995de154272108c3c4937e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 33099,
"upload_time": "2024-04-05T16:32:06",
"upload_time_iso_8601": "2024-04-05T16:32:06.844169Z",
"url": "https://files.pythonhosted.org/packages/04/2c/73e6afface38fbc8f30a8c39adee2aae9a974bf1b14f581b065ff4dd0948/chck-0.0.75-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d0eb58ee049c9eb8991affbc122a972c377b1aa44020bd2dac5c2d32330608a6",
"md5": "0e82e2dd0b10184cea56ec63e0afbbc5",
"sha256": "9a1d5ed5cf8facdc6ad936c6b6b0e505278167fe53e5687f90bdad435844e23a"
},
"downloads": -1,
"filename": "chck-0.0.75.tar.gz",
"has_sig": false,
"md5_digest": "0e82e2dd0b10184cea56ec63e0afbbc5",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 26109,
"upload_time": "2024-04-05T16:32:08",
"upload_time_iso_8601": "2024-04-05T16:32:08.227328Z",
"url": "https://files.pythonhosted.org/packages/d0/eb/58ee049c9eb8991affbc122a972c377b1aa44020bd2dac5c2d32330608a6/chck-0.0.75.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-05 16:32:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "chck",
"github_not_found": true,
"lcname": "chck"
}
JSON
