datamuse 0.1.0__py3-none-any.whl

datamuse/__init__.py

@@ -0,0 +1,5 @@
+from .datamuse import Datamuse
+
+__all__ = [
+    "Datamuse",
+]

datamuse/annotations.py

@@ -0,0 +1,40 @@
+from types import MappingProxyType
+from typing import Literal, LiteralString, TypeAlias
+
+Word: TypeAlias = LiteralString
+
+
+RelatedWordCode = Literal[
+    "nouns_adjective",
+    "adjectives_noun",
+    "synonyms",
+    "triggers",
+    "antonyms",
+    "hypernyms",
+    "hyponyms",
+    "holonyms",
+    "meronyms",
+    "frequent_followers",
+    "frequent_predecessors",
+    "homophones",
+    "consonant",
+]
+
+
+_lookup_related_code = MappingProxyType(
+    {
+        "nouns_adjective": "jja",
+        "adjectives_noun": "jjb",
+        "synonyms": "syn",
+        "triggers": "trg",
+        "antonyms": "ant",
+        "hypernyms": "spc",
+        "hyponyms": "gen",
+        "holonyms": "com",
+        "meronyms": "par",
+        "frequent_followers": "bga",
+        "frequent_predecessors": "bgb",
+        "homophones": "hom",
+        "consonant": "cns",
+    }
+)

datamuse/datamuse.py

@@ -0,0 +1,99 @@
+import functools
+from typing import final
+
+import certifi
+import urllib3
+
+from datamuse.annotations import RelatedWordCode, Word, _lookup_related_code
+
+
+@final
+class Datamuse:
+    """
+    The [Datamuse](https://www.datamuse.com/) [API](https://www.datamuse.com/api/) is a word-finding query engine for developers.
+
+    You can use it in your apps to find words that match a given set of constraints and that are likely in a given context.
+    You can specify a wide variety of constraints on meaning, spelling, sound, and vocabulary in your queries, in any combination.
+    """
+
+    __API_URL = "api.datamuse.com"
+    __slots__ = ("__pool",)
+
+    def __init__(self) -> None:
+        self.__pool = urllib3.HTTPSConnectionPool(
+            host=self.__API_URL,
+            port=443,
+            cert_reqs="CERT_REQUIRED",
+            ca_certs=certifi.where(),
+        )
+
+    @functools.lru_cache
+    def __get_words(self, **kwds: Word | RelatedWordCode) -> list[Word]:
+        response = self.__pool.request(method="GET", url="/words", fields=kwds)
+        return [word["word"] for word in response.json()]
+
+    @functools.lru_cache
+    def __get_suggestions(self, **kwds: Word | RelatedWordCode) -> list[Word]:
+        response = self.__pool.request(method="GET", url="/sug", fields=kwds)
+        return [word["word"] for word in response.json()]
+
+    def synonyms(self, ml: Word):
+        """
+        words with a meaning similar to `ml`
+
+        :param ml: means like
+        """
+        return self.__get_words(ml=ml)
+
+    def associations(self, ml: Word, start: Word = "*", end: Word = "*"):
+        """
+        words related to `ml`
+
+        :param ml: means like
+        :param start: start with
+        :param end: end in
+        """
+        return self.__get_words(ml=ml, sp=start + end)
+
+    def homophones(self, sl: Word):
+        """
+        words that sound like `sl`
+
+        :param sl: sounds like
+        """
+        return self.__get_words(sl=sl)
+
+    def pattern(self, start: Word, end: Word, letters: int):
+        """
+        words that start with `start`, end in `end`, and have `letters` in between
+
+        :param start: start with
+        :param end: end in
+        :param letters: letters in between
+        """
+        return self.__get_words(sp=f"{start[0]}{'?' * letters}{end[0]}")
+
+    def orthographic_neighbours(self, sp: Word):
+        """
+        words that are spelled similarly to `sp`
+
+        :param sp: spelled like
+        """
+        return self.__get_words(sp=sp)
+
+    def related(self, word: Word, rel: RelatedWordCode):
+        """
+        words that are related by `rel`
+
+        :param word: the word
+        :param rel: related word
+        """
+        return self.__get_words(**{f"rel_{_lookup_related_code[rel]}": word})
+
+    def suggestions(self, s: Word):
+        """
+        sugesstions from prefix hint string `s`
+
+        :param s: prefix hint string
+        """
+        return self.__get_suggestions(s=s)

datamuse-0.1.0.dist-info/METADATA

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: datamuse
+Version: 0.1.0
+Summary: datamuse is a simple wrapper around the datamuse api https://www.datamuse.com/api/
+Author-email: Bivas Kumar <thetrotfreak@yahoo.com>
+License-Expression: MIT
+Project-URL: Homepage, https://pypi.org/project/datamuse
+Project-URL: Source, https://github.com/thetrotfreak/datamuse
+Project-URL: Documentation, https://thetrotfreak.github.io/datamuse
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: certifi>=2026.1.4
+Requires-Dist: urllib3>=2.6.3
+Dynamic: license-file
+
+# datamuse
+
+`datamuse` is a simple wrapper around the [datamuse](https://www.datamuse.com/) [api](https://www.datamuse.com/api/)
+
+## Installing
+
+You can install `datamuse` via `pip` / `pypi`:
+
+```shell
+pip install datamuse
+```
+
+## Acknowledgements
+
+- [Harvey Beeferman, 1942–2024](https://beeferman.org/harvey/)
+- [datamuse](https://www.datamuse.com/)

datamuse-0.1.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+datamuse/__init__.py,sha256=3iBEY2GhRlufmsa_jbPcL5pNmFxlcmVBnPDrb2viXF0,62
+datamuse/annotations.py,sha256=sH2B4EQsTMLCFrGJ4b90UFME3TdezOVqRfTdEyXIPlI,850
+datamuse/datamuse.py,sha256=cSH0UIESr7UP_X2w6dyo6TfFXoSveiXJ-MyDUuVvmbc,2957
+datamuse-0.1.0.dist-info/licenses/LICENSE,sha256=QOL-I0yJ7jgs2oNQFHl_Q5oYfQ9dbcXxE9lQC3o8hhs,1068
+datamuse-0.1.0.dist-info/METADATA,sha256=-KIThoI4BefAbVP-fkxzfZLfp4VNNoDExXB8-UPrKig,1027
+datamuse-0.1.0.dist-info/WHEEL,sha256=qELbo2s1Yzl39ZmrAibXA2jjPLUYfnVhUNTlyF1rq0Y,92
+datamuse-0.1.0.dist-info/top_level.txt,sha256=WPSt0EOXULT7kkMOZin9HFm1RNBYgoLM0q7rTxcDH_w,9
+datamuse-0.1.0.dist-info/RECORD,,

datamuse-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.10.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

datamuse-0.1.0.dist-info/licenses/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Bivas Kumar
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

datamuse-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+datamuse