# ncall
<!-- 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 synset --file env.yml
```
### Install
``` sh
pip install -e .
# install from pypi
pip install synset
```
### nbdev
``` sh
# activate conda environment
$ conda activate synset
# make sure the synset package is installed in development mode
$ pip install -e .
# make changes under nbs/ directory
# ...
# compile to have changes apply to the synset 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/synset):
``` sh
$ pip install git+https://github.com/dsm-72/synset.git
```
or from [conda](https://anaconda.org/dsm-72/synset)
``` sh
$ conda install -c dsm-72 synset
```
or from [pypi](https://pypi.org/project/synset/)
``` sh
$ pip install synset
```
## Documentation
Documentation can be found hosted on GitHub
[repository](https://github.com/dsm-72/synset)
[pages](https://dsm-72.github.io/synset/). Additionally you can find
package manager specific guidelines on
[conda](https://anaconda.org/dsm-72/synset) and
[pypi](https://pypi.org/project/synset/) respectively.
``` python
NOOP = ncall('noop', noop, *IDENTITY_SYNONYMS, fullrepr=True)
NOOP
```
noop(x: Any, *args, **kwargs) -> Any
``` python
NOOP == 'identity'
```
True
``` python
NOOP('Hello')
```
'Hello'
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/ncall",
"name": "ncall",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "named callable ncall syn alias fuzzy string matching nym str fuz fuzstr nymstr atyp ispec indoc dynattr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/cd/2f/9771e2fe664ac5603507fd79d301781d9217502da580ec8ddb4d91e73cbc/ncall-0.0.3.tar.gz",
"platform": null,
"description": "# ncall\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 synset --file env.yml\n```\n\n### Install\n\n``` sh\npip install -e .\n\n# install from pypi\npip install synset\n```\n\n### nbdev\n\n``` sh\n# activate conda environment\n$ conda activate synset\n\n# make sure the synset 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 synset 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/synset):\n\n``` sh\n$ pip install git+https://github.com/dsm-72/synset.git\n```\n\nor from [conda](https://anaconda.org/dsm-72/synset)\n\n``` sh\n$ conda install -c dsm-72 synset\n```\n\nor from [pypi](https://pypi.org/project/synset/)\n\n``` sh\n$ pip install synset\n```\n\n## Documentation\n\nDocumentation can be found hosted on GitHub\n[repository](https://github.com/dsm-72/synset)\n[pages](https://dsm-72.github.io/synset/). Additionally you can find\npackage manager specific guidelines on\n[conda](https://anaconda.org/dsm-72/synset) and\n[pypi](https://pypi.org/project/synset/) respectively.\n\n``` python\nNOOP = ncall('noop', noop, *IDENTITY_SYNONYMS, fullrepr=True)\nNOOP\n```\n\n noop(x: Any, *args, **kwargs) -> Any\n\n``` python\nNOOP == 'identity'\n```\n\n True\n\n``` python\nNOOP('Hello')\n```\n\n 'Hello'\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "ncall",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://github.com/dsm-72/ncall"
},
"split_keywords": [
"named",
"callable",
"ncall",
"syn",
"alias",
"fuzzy",
"string",
"matching",
"nym",
"str",
"fuz",
"fuzstr",
"nymstr",
"atyp",
"ispec",
"indoc",
"dynattr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "1c558b74ac05174ac284b0c95d73b5c329b17df6e8c478c6424ce7abe9e7c5c4",
"md5": "0fb6ee9a5d193812f4c7e63ba4d77cbf",
"sha256": "27aed140ec8f6cb9120fa389b0f889147b576e8a994869413de395f772b78f6e"
},
"downloads": -1,
"filename": "ncall-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0fb6ee9a5d193812f4c7e63ba4d77cbf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11811,
"upload_time": "2024-03-24T17:14:31",
"upload_time_iso_8601": "2024-03-24T17:14:31.876174Z",
"url": "https://files.pythonhosted.org/packages/1c/55/8b74ac05174ac284b0c95d73b5c329b17df6e8c478c6424ce7abe9e7c5c4/ncall-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd2f9771e2fe664ac5603507fd79d301781d9217502da580ec8ddb4d91e73cbc",
"md5": "13f4efb43fe1060188184ab9ebfca650",
"sha256": "e53a9759366b257f84f602c7e2b75736b27b681bab10cf8700d876af53a60754"
},
"downloads": -1,
"filename": "ncall-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "13f4efb43fe1060188184ab9ebfca650",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 12907,
"upload_time": "2024-03-24T17:14:34",
"upload_time_iso_8601": "2024-03-24T17:14:34.592276Z",
"url": "https://files.pythonhosted.org/packages/cd/2f/9771e2fe664ac5603507fd79d301781d9217502da580ec8ddb4d91e73cbc/ncall-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-24 17:14:34",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "ncall",
"github_not_found": true,
"lcname": "ncall"
}
JSON
