# inhum
<!-- 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 inhum --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install inhum
```
### nbdev
``` sh
# activate conda environment
$ conda activate inhum
# make sure the inhum package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the inhum 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/inhum):
``` sh
$ pip install git+https://github.com/dsm-72/inhum.git
```
or from [conda](https://anaconda.org/dsm-72/inhum)
``` sh
$ conda install -c dsm-72 inhum
```
or from [pypi](https://pypi.org/project/inhum/)
``` sh
$ pip install inhum
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/inhum)
[pages](https://dsm-72.github.io/inhum/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/inhum) and
[pypi](https://pypi.org/project/inhum/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/inhum",
"name": "inhum",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python inhum",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/7d/6f/cfdedc3ff6cc9c02dd4cbea8fdf670c1ef6aab62a19daf848711059edb41/inhum-0.0.8.tar.gz",
"platform": null,
"description": "# inhum\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 inhum --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install inhum\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate inhum\n\n# make sure the inhum 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 inhum 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/inhum):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/inhum.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/inhum)\n\n``` sh\n$ conda install -c dsm-72 inhum\n```\n\nor from [pypi](https://pypi.org/project/inhum/)\n\n``` sh\n$ pip install inhum\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/inhum)\n[pages](https://dsm-72.github.io/inhum/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/inhum) and\n[pypi](https://pypi.org/project/inhum/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "utility for scaffolding nbdev projects",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/dsm-72/inhum"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"inhum"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "3d6218332d63a32b8e2d035528b25eed89588ea2a12b56b31b05c5d63a058f0d",
"md5": "ead4d3725447386e0b06420061380d9d",
"sha256": "78b34d8c845259aa9c534617fc191aaf05001d8939d9b7dfd91f92e65aeca129"
},
"downloads": -1,
"filename": "inhum-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "ead4d3725447386e0b06420061380d9d",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 10089,
"upload_time": "2023-10-26T18:48:58",
"upload_time_iso_8601": "2023-10-26T18:48:58.506268Z",
"url": "https://files.pythonhosted.org/packages/3d/62/18332d63a32b8e2d035528b25eed89588ea2a12b56b31b05c5d63a058f0d/inhum-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "7d6fcfdedc3ff6cc9c02dd4cbea8fdf670c1ef6aab62a19daf848711059edb41",
"md5": "19f0b3c4d18726f63097c942a162d90b",
"sha256": "a3e7df61f57b054385c6ca04ba734c72099a2d275536f3a521aed32574c25c51"
},
"downloads": -1,
"filename": "inhum-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "19f0b3c4d18726f63097c942a162d90b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 10593,
"upload_time": "2023-10-26T18:48:59",
"upload_time_iso_8601": "2023-10-26T18:48:59.506325Z",
"url": "https://files.pythonhosted.org/packages/7d/6f/cfdedc3ff6cc9c02dd4cbea8fdf670c1ef6aab62a19daf848711059edb41/inhum-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-10-26 18:48:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "inhum",
"github_not_found": true,
"lcname": "inhum"
}
JSON
