rhymbrain api的python包装器
pyrhyme的Python项目详细描述
pyrhyme是韵脑api的包装。它旨在提供一种与rhymebrain_uuAPI交互的pythonic方式。
需求、安装和兼容性
----------
包含在"requirements.txt"中的唯一需求是用于请求。如果使用pip,则可以安装"pyrhyme":
。代码块::bash
$pip安装请求pyrhyme
代码块::bash
$pip install requests
$pip install-e git+https://github.com/gsejas/pyrhyme.git\egg=pyrhyme
`` pyrhyme``已经针对python版本3.6进行了测试。
Getting Started
----
使用``pyrhyme``很简单,目的是在没有任何json交互的情况下提供与api的交互。
YRHyme.韵脑`
类。这个类可以选择接受两个参数:``api_key``和``strict``.
``api_key`` agument如果没有预先设置,将默认为公钥
(见上文)。"`strict`"参数控制在没有返回结果时api的反应方式。如果启用,将引发异常,
否则,将返回"none"。
…代码块:python
>;>import pyrhyme
>;>g=pyrhyme.rhymebrain()
对于
``pyrhyme.rhymebrain``对象,有几个关键的方法,您需要了解
rhymimg
++++br/>搜索给定单词的押韵。
请注意,此方法是一个押韵词生成器。可选地接受最大数量的结果。
-**word**:搜索押韵的单词
-**lang**:ISO639-1语言代码(可选)。例如en、de、es、fr、ru
-**maxresults**:(可选)要返回的结果数。如果不包含此参数,rhymbrain将根据单词有多少好听的押韵来选择要显示的单词数。
这种方法会有那种效果。相当于:
…代码块::python
>;>g=pyrhyme.rhymebrain()
>;>results=[x代表x,g.rhymimg('foo')]
=--注::
为了您的方便,上述"pyrhyme.rhymebrain"的方法也在模块
级别公开。例如:
…代码块::python
>;>;来自pyrhyme import rhyming
>;>;img=rhyming('foo',lang='en')
---------------------------
处理结果t表示单个图像包装在一个
``pyrhyme.rhymword``对象中。此对象的行为类似于字典,但
也将键作为属性公开。注意,它们不是api响应对象的直接镜像;它们的目标是更简单。结构
遵循这种布局::
<;result object>;
-单词:押韵单词
-分数:押韵单词的分数。
300分及以上的分数是完美的押韵。
0到300分之间的分数接近押韵。没有相似发音辅音的单词。
具有相同分数的单词首先列出最匹配的发音。如果以后再次按分数排序,最好在将结果显示给用户之前保留此顺序。
-标志:提供有关该单词更多信息的字母列表。
a:该单词具有攻击性。
B:这个词可能在大多数字典里都能找到。
C:发音是有把握的。它不是自动生成的。
-音节:押韵单词中音节数的估计。
-freq:一个数字,告诉你这个单词有多常见。这个数字是普通文本使用频率的对数。目前,最大的可能值是34。
-pron:结果是包含单词语音转录的字符串。
这里描述了使用的arpabet格式。这些标志指示是否自动生成发音。自动生成的语音可能不准确。
-ipa:使用国际语音字母表的语音转录。
此转录可能包含Unicode字符。由于响应是json格式,
Unicode字符使用语法进行编码。
-组合:端口表没有或两个可能的拼写。当存在多个
可能性时,它们用逗号分隔。
-来源:端口表中包含的两个单词,用逗号分隔。
例如:
代码块::python
>;>;来自pyrhyme import rhyme
>;>;r=rhyme('foo')
>;>;r.word
changelog
--
<0.1
++
-初始版本
/>由"jorge sequeira"开发,并根据麻省理工学院许可条款获得许可。
欢迎并感谢您的贡献!
…_韵脑:https://韵脑.com
…_请求:https://pypi.python.org/pypi/requests/1.2.3
…_` API文档`:https://rhymbrain.com/api.html
…_` jorge sequeira`:jsequeira03@gmail.com
需求、安装和兼容性
----------
包含在"requirements.txt"中的唯一需求是用于请求。如果使用pip,则可以安装"pyrhyme":
。代码块::bash
$pip安装请求pyrhyme
代码块::bash
$pip install requests
$pip install-e git+https://github.com/gsejas/pyrhyme.git\egg=pyrhyme
`` pyrhyme``已经针对python版本3.6进行了测试。
Getting Started
----
使用``pyrhyme``很简单,目的是在没有任何json交互的情况下提供与api的交互。
YRHyme.韵脑`
类。这个类可以选择接受两个参数:``api_key``和``strict``.
``api_key`` agument如果没有预先设置,将默认为公钥
(见上文)。"`strict`"参数控制在没有返回结果时api的反应方式。如果启用,将引发异常,
否则,将返回"none"。
…代码块:python
>;>import pyrhyme
>;>g=pyrhyme.rhymebrain()
对于
``pyrhyme.rhymebrain``对象,有几个关键的方法,您需要了解
rhymimg
++++br/>搜索给定单词的押韵。
请注意,此方法是一个押韵词生成器。可选地接受最大数量的结果。
-**word**:搜索押韵的单词
-**lang**:ISO639-1语言代码(可选)。例如en、de、es、fr、ru
-**maxresults**:(可选)要返回的结果数。如果不包含此参数,rhymbrain将根据单词有多少好听的押韵来选择要显示的单词数。
这种方法会有那种效果。相当于:
…代码块::python
>;>g=pyrhyme.rhymebrain()
>;>results=[x代表x,g.rhymimg('foo')]
=--注::
为了您的方便,上述"pyrhyme.rhymebrain"的方法也在模块
级别公开。例如:
…代码块::python
>;>;来自pyrhyme import rhyming
>;>;img=rhyming('foo',lang='en')
---------------------------
处理结果t表示单个图像包装在一个
``pyrhyme.rhymword``对象中。此对象的行为类似于字典,但
也将键作为属性公开。注意,它们不是api响应对象的直接镜像;它们的目标是更简单。结构
遵循这种布局::
<;result object>;
-单词:押韵单词
-分数:押韵单词的分数。
300分及以上的分数是完美的押韵。
0到300分之间的分数接近押韵。没有相似发音辅音的单词。
具有相同分数的单词首先列出最匹配的发音。如果以后再次按分数排序,最好在将结果显示给用户之前保留此顺序。
-标志:提供有关该单词更多信息的字母列表。
a:该单词具有攻击性。
B:这个词可能在大多数字典里都能找到。
C:发音是有把握的。它不是自动生成的。
-音节:押韵单词中音节数的估计。
-freq:一个数字,告诉你这个单词有多常见。这个数字是普通文本使用频率的对数。目前,最大的可能值是34。
-pron:结果是包含单词语音转录的字符串。
这里描述了使用的arpabet格式。这些标志指示是否自动生成发音。自动生成的语音可能不准确。
-ipa:使用国际语音字母表的语音转录。
此转录可能包含Unicode字符。由于响应是json格式,
Unicode字符使用语法进行编码。
-组合:端口表没有或两个可能的拼写。当存在多个
可能性时,它们用逗号分隔。
-来源:端口表中包含的两个单词,用逗号分隔。
例如:
代码块::python
>;>;来自pyrhyme import rhyme
>;>;r=rhyme('foo')
>;>;r.word
changelog
--
<0.1
++
-初始版本
/>由"jorge sequeira"开发,并根据麻省理工学院许可条款获得许可。
欢迎并感谢您的贡献!
…_韵脑:https://韵脑.com
…_请求:https://pypi.python.org/pypi/requests/1.2.3
…_` API文档`:https://rhymbrain.com/api.html
…_` jorge sequeira`:jsequeira03@gmail.com