#+TITLE: Standard Yawlib API

* Must-support APIs
** Select by ID(s)
- get_synset(synsetid)
- get_synsets(synsetids)

** Select by sensekey(s)
- get_by_key(sensekey)
- get_by_keys(sensekeys)

** Helpers
sk2sid(sensekey)

** Search by lemma, pos
- search(lemma, pos=None, deep_select=True, ignore_case=True, lang='eng', **kwargs)

** Full text search
- search_def(query, deep_select=True, ignore_case=True, lang='eng', **kwargs)
- search_ex(query, deep_select=True, ignore_case=True, lang='eng', **kwargs)

** Get related synsets
These functions should return a list of synset objects
- hypernyms(synsetid, deep_select=True)
- hyponyms(synsetid, deep_select=True)
- hypehypo(synsetid, deep_select=True)

* Support datasets
** WordnetSQL
** GlossedWordnet
** Open Multilingual Wordnet

#+TITLE: Standard Yawlib API

* Must-support APIs
** Select by ID(s)
- get_synset(synsetid)
- get_synsets(synsetids)

** Select by sensekey(s)
- get_by_key(sensekey)
- get_by_keys(sensekeys)

** Helpers
sk2sid(sensekey)

** Search by lemma, pos
- search(lemma, pos=None, deep_select=True, ignore_case=True, lang='eng', **kwargs)

** Full text search
- search_def(query, deep_select=True, ignore_case=True, lang='eng', **kwargs)
- search_ex(query, deep_select=True, ignore_case=True, lang='eng', **kwargs)

** Get related synsets
These functions should return a list of synset objects
- hypernyms(synsetid, deep_select=True)
- hyponyms(synsetid, deep_select=True)
- hypehypo(synsetid, deep_select=True)

* REST APIs
** Flask
To run Yawol Flask, use
```bash
# to debug, use
# export FLASK_DEBUG=1
python3 -m yawlib.yawol.app
```
*** Testing API
To ensure that Yawol is running, visit this URL: http://localhost:5000/yawol/version
(Change the port 5000 to your actual port)

** Django
To run Yawol Django, use
```bash
python3 manage.py runserver
```

*** Testing API
To ensure that Yawol is running, visit this URL: http://localhost:8000/yawol/version
(Change the port 8000 to your actual port)

* Support datasets
** WordnetSQL
** GlossedWordnet
** Open Multilingual Wordnet

Add guide about running Yawol-Flask & Yawol-Django
Add guide about running Yawol-Flask & Yawol-Django
