# synset
<!-- 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
syn = synset(
'alias',
'aka', 'tags', 'alts', 'names', 'labels', 'aliases', 'handles',
'monikers', 'codenames', 'nicknames', 'cognomen', 'sobriquets',
'variations', 'pseudonames', 'alternatives', 'recognized',
'noms', # (French, names)
'nafn', # (Icelandic, name)
'nefndur', # (Icelandic, named)
'dulnefni', # (Icelandic, pseudonym)
'samnefni', # (Icelandic, alias / alised)
fullrepr=True
)
syn, syn == 'nafn'
```
(alias (21 aliases), True)
``` python
no_alias = synset('none', )
no_alias, no_alias == 'None'
```
(none (0 aliases), True)
Raw data
{
"_id": null,
"home_page": "https://github.com/dsm-72/synset",
"name": "synset",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": "syn synonyms alias set aliasable canon canonical name things with fuzzy string matching synset nym str fuz fuzstr atyp ispec indoc dynattr",
"author": "dsm-72",
"author_email": "sumner.magruder@yale.edu",
"download_url": "https://files.pythonhosted.org/packages/4a/54/38e34cc9d4c926c6d61142507aa6b9dda369b57f41fdf6c5b60ff8adf878/synset-0.0.15.tar.gz",
"platform": null,
"description": "# synset\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\nsyn = synset(\n 'alias', \n 'aka', 'tags', 'alts', 'names', 'labels', 'aliases', 'handles', \n 'monikers', 'codenames', 'nicknames', 'cognomen', 'sobriquets', \n 'variations', 'pseudonames', 'alternatives', 'recognized',\n 'noms', # (French, names)\n 'nafn', # (Icelandic, name)\n 'nefndur', # (Icelandic, named)\n 'dulnefni', # (Icelandic, pseudonym)\n 'samnefni', # (Icelandic, alias / alised)\n fullrepr=True\n)\nsyn, syn == 'nafn'\n```\n\n (alias (21 aliases), True)\n\n``` python\nno_alias = synset('none', )\nno_alias, no_alias == 'None'\n```\n\n (none (0 aliases), True)\n",
"bugtrack_url": null,
"license": "Apache Software License 2.0",
"summary": "synset",
"version": "0.0.15",
"project_urls": {
"Homepage": "https://github.com/dsm-72/synset"
},
"split_keywords": [
"syn",
"synonyms",
"alias",
"set",
"aliasable",
"canon",
"canonical",
"name",
"things",
"with",
"fuzzy",
"string",
"matching",
"synset",
"nym",
"str",
"fuz",
"fuzstr",
"atyp",
"ispec",
"indoc",
"dynattr"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bcee2acde0e0e2fdc018c3b3431349952845e6d5071e7402a3d1ba28e3307fda",
"md5": "84c3561844829dc81fd392401d54ecea",
"sha256": "72213b12eeb31522db988a5dee11866902bf74d9acda6bb36c36540b3b3b775c"
},
"downloads": -1,
"filename": "synset-0.0.15-py3-none-any.whl",
"has_sig": false,
"md5_digest": "84c3561844829dc81fd392401d54ecea",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 11854,
"upload_time": "2024-03-24T17:13:42",
"upload_time_iso_8601": "2024-03-24T17:13:42.847162Z",
"url": "https://files.pythonhosted.org/packages/bc/ee/2acde0e0e2fdc018c3b3431349952845e6d5071e7402a3d1ba28e3307fda/synset-0.0.15-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4a5438e34cc9d4c926c6d61142507aa6b9dda369b57f41fdf6c5b60ff8adf878",
"md5": "dd14089f7e3c984423004acc6801407c",
"sha256": "7417c55c1872962f64ae1637157d49295774529e6869fd6312645a185c8d9b0e"
},
"downloads": -1,
"filename": "synset-0.0.15.tar.gz",
"has_sig": false,
"md5_digest": "dd14089f7e3c984423004acc6801407c",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 13617,
"upload_time": "2024-03-24T17:14:05",
"upload_time_iso_8601": "2024-03-24T17:14:05.924110Z",
"url": "https://files.pythonhosted.org/packages/4a/54/38e34cc9d4c926c6d61142507aa6b9dda369b57f41fdf6c5b60ff8adf878/synset-0.0.15.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-03-24 17:14:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "dsm-72",
"github_project": "synset",
"github_not_found": true,
"lcname": "synset"
}
JSON
