synset

Developer Guide

Setup

# create conda environment
$ mamba env create -f env.yml

# update conda environment
$ mamba env update -n synset --file env.yml

Install

pip install -e .

 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

# 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:

$ pip install git+https://github.com/dsm-72/synset.git

or from conda

$ conda install -c dsm-72 synset

or from pypi

$ pip install synset

Documentation

Documentation can be found hosted on GitHub repository pages. Additionally you can find package manager specific guidelines on conda and pypi respectively.

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)

no_alias = synset('none', )
no_alias, no_alias == 'None'

(none (0 aliases), True)