# idfunc
<!-- 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 idfunc --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install idfunc
```
### nbdev
``` sh
# activate conda environment
$ conda activate idfunc
# make sure the idfunc package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the idfunc 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/idfunc):
``` sh
$ pip install git+https://github.com/dsm-72/idfunc.git
```
or from [conda](https://anaconda.org/dsm-72/idfunc)
``` sh
$ conda install -c dsm-72 idfunc
```
or from [pypi](https://pypi.org/project/idfunc/)
``` sh
$ pip install idfunc
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/idfunc)
[pages](https://dsm-72.github.io/idfunc/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/idfunc) and
[pypi](https://pypi.org/project/idfunc/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/idfunc",
"name": "idfunc",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "id identity func function identity funciton noop no operation nbdev jupyter notebook python",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/dc/e6/0cd5cf3e80a7293ca4ef25a60677ecb67be580baa9ec0a1f29371c9b88ef/idfunc-0.0.8.tar.gz",
"platform": null,
"description": "# idfunc\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 idfunc --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install idfunc\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate idfunc\n\n# make sure the idfunc 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 idfunc 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/idfunc):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/idfunc.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/idfunc)\n\n``` sh\n$ conda install -c dsm-72 idfunc\n```\n\nor from [pypi](https://pypi.org/project/idfunc/)\n\n``` sh\n$ pip install idfunc\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/idfunc)\n[pages](https://dsm-72.github.io/idfunc/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/idfunc) and\n[pypi](https://pypi.org/project/idfunc/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "identity function",
"version": "0.0.8",
"project_urls": {
"Homepage": "https://github.com/dsm-72/idfunc"
},
"split_keywords": [
"id",
"identity",
"func",
"function",
"identity",
"funciton",
"noop",
"no",
"operation",
"nbdev",
"jupyter",
"notebook",
"python"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "dcdaaf66b19d63904850d50479924e4abcfce0c6b44dc528faaf2f3dc8cac3af",
"md5": "4fc3af5877465a4bfa48835cef3a035e",
"sha256": "f962877a244249cdc66df7c4edd6a6c0c068d781772fca6b6b0c01729f80b973"
},
"downloads": -1,
"filename": "idfunc-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "4fc3af5877465a4bfa48835cef3a035e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 8428,
"upload_time": "2023-11-13T14:21:12",
"upload_time_iso_8601": "2023-11-13T14:21:12.243181Z",
"url": "https://files.pythonhosted.org/packages/dc/da/af66b19d63904850d50479924e4abcfce0c6b44dc528faaf2f3dc8cac3af/idfunc-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "dce60cd5cf3e80a7293ca4ef25a60677ecb67be580baa9ec0a1f29371c9b88ef",
"md5": "04abdfca50485bf3df8daa4199e9370b",
"sha256": "f0aabb391c464f297b9ebad31e1a7dfe29c9bae8e6b6c2e5f662ba37dddfe6b7"
},
"downloads": -1,
"filename": "idfunc-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "04abdfca50485bf3df8daa4199e9370b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 8921,
"upload_time": "2023-11-13T14:21:13",
"upload_time_iso_8601": "2023-11-13T14:21:13.788136Z",
"url": "https://files.pythonhosted.org/packages/dc/e6/0cd5cf3e80a7293ca4ef25a60677ecb67be580baa9ec0a1f29371c9b88ef/idfunc-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 14:21:13",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "idfunc",
"github_not_found": true,
"lcname": "idfunc"
}
JSON
