# ispec
<!-- 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 ispec --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install ispec
```
### nbdev
``` sh
# activate conda environment
$ conda activate ispec
# make sure the ispec package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the ispec 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/ispec):
``` sh
$ pip install git+https://github.com/dsm-72/ispec.git
```
or from [conda](https://anaconda.org/dsm-72/ispec)
``` sh
$ conda install -c dsm-72 ispec
```
or from [pypi](https://pypi.org/project/ispec/)
``` sh
$ pip install ispec
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/ispec)
[pages](https://dsm-72.github.io/ispec/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/ispec) and
[pypi](https://pypi.org/project/ispec/) respectively.
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/ispec",
"name": "ispec",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": "",
"keywords": "nbdev jupyter notebook python inspect ispec utils args kwo kwargs kwonly",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/0c/d1/fb0459450e78247af2d49bdb1b556c7472eba51603670b0ebe7098083ff7/ispec-0.0.18.tar.gz",
"platform": null,
"description": "# ispec\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 ispec --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install ispec\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate ispec\n\n# make sure the ispec 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 ispec 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/ispec):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/ispec.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/ispec)\n\n``` sh\n$ conda install -c dsm-72 ispec\n```\n\nor from [pypi](https://pypi.org/project/ispec/)\n\n``` sh\n$ pip install ispec\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/ispec)\n[pages](https://dsm-72.github.io/ispec/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/ispec) and\n[pypi](https://pypi.org/project/ispec/) respectively.\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ispec",
"version": "0.0.18",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ispec"
},
"split_keywords": [
"nbdev",
"jupyter",
"notebook",
"python",
"inspect",
"ispec",
"utils",
"args",
"kwo",
"kwargs",
"kwonly"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f58d2be571b34ed35056b4f7cf3c7908962c124d9684faa01e4b8c8e84aa5e19",
"md5": "e8714d2a14e07fa70ad1435d032c79f6",
"sha256": "a19107be83f0d2569609ea34a57cbb04e493de6fb97c5a2676a92c83a178a8ca"
},
"downloads": -1,
"filename": "ispec-0.0.18-py3-none-any.whl",
"has_sig": false,
"md5_digest": "e8714d2a14e07fa70ad1435d032c79f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 22580,
"upload_time": "2024-03-13T17:51:32",
"upload_time_iso_8601": "2024-03-13T17:51:32.269625Z",
"url": "https://files.pythonhosted.org/packages/f5/8d/2be571b34ed35056b4f7cf3c7908962c124d9684faa01e4b8c8e84aa5e19/ispec-0.0.18-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "0cd1fb0459450e78247af2d49bdb1b556c7472eba51603670b0ebe7098083ff7",
"md5": "bcc1296c0d3582c354b24416f2261771",
"sha256": "063d28aef5b5983b62edc0b555a830ab6ac91289d0e137a7f6b7b9f0c939776a"
},
"downloads": -1,
"filename": "ispec-0.0.18.tar.gz",
"has_sig": false,
"md5_digest": "bcc1296c0d3582c354b24416f2261771",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 19090,
"upload_time": "2024-03-13T17:51:38",
"upload_time_iso_8601": "2024-03-13T17:51:38.274537Z",
"url": "https://files.pythonhosted.org/packages/0c/d1/fb0459450e78247af2d49bdb1b556c7472eba51603670b0ebe7098083ff7/ispec-0.0.18.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-13 17:51:38",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ispec",
"github_not_found": true,
"lcname": "ispec"
}
JSON
