forked from wordnik/wordnik-python
-
Notifications
You must be signed in to change notification settings - Fork 0
Expand file tree
/
Copy pathREADME
More file actions
414 lines (374 loc) · 18.3 KB
/
README
File metadata and controls
414 lines (374 loc) · 18.3 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
<!doctype html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
<html><head><title>Python: class Wordnik</title>
</head><body bgcolor="#f0f0f8">
<p>
<table width="100%" cellspacing=0 cellpadding=2 border=0 summary="section">
<tr bgcolor="#ffc8d8">
<td colspan=3 valign=bottom> <br>
<font color="#000000" face="helvetica, arial"><strong>wordnik.Wordnik</strong> = <a name="wordnik.Wordnik">class Wordnik</a>(<a href="__builtin__.html#object">__builtin__.object</a>)</font></td></tr>
<tr bgcolor="#ffc8d8"><td rowspan=2><tt> </tt></td>
<td colspan=2><tt>A generic Wordnik object. Use me to interact with the Wordnik API.<br>
<br>
All of my methods can be called in multiple ways. All positional<br>
arguments passed into one of my methods (with the exception of "format")<br>
will be substituted for the correponding path parameter, if possible.<br>
For example, consider the "get_word_examples" method. The URI path is:<br>
<br>
/word.{format}/{word}/examples<br>
<br>
So we can skip format (default format is JSON) and infer that the first<br>
positional argument is the word we want examples for. Hence:<br>
<br>
Wordnik.<a href="#wordnik.Wordnik-get_word_examples">get_word_examples</a>('cat')<br>
<br>
All other (non-path) arguments are keyword arguments. The "format"<br>
paramater can be passed in this way as well. Hence:<br>
<br>
Wordnik.<a href="#wordnik.Wordnik-get_word_examples">get_word_examples</a>('cat', format='xml', limit=500)<br>
<br>
In the case where you're making a POST, you will need a "body" keyword:<br>
<br>
Wordnik.<a href="#wordnik.Wordnik-put_word_list">put_word_list</a>(wordListId=1234, body="Some HTTP body")<br> </tt></td></tr>
<tr><td> </td>
<td width="100%">Methods defined here:<br>
<dl><dt><a name="Wordnik-__init__"><strong>__init__</strong></a>(self, api_key<font color="#909090">=None</font>)</dt><dd><tt>Initialize a Wordnik object. You must pass in an API key when<br>
you make a new Wordnik. We don't validate the API key until the<br>
first call against the API is made, at which point you'll find<br>
out if it's good.</tt></dd></dl>
<dl><dt><a name="Wordnik-delete_user_word_of_the_day_list"><strong>delete_user_word_of_the_day_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Deletes a specific word from a user's WordOfTheDayList<br>
/user.{format}/{username}/wordOfTheDayList/{permalink}/{wordToDelete}<br>
<br>
Path Parameters:<br>
username<br>
permalink<br>
wordToDelete</tt></dd></dl>
<dl><dt><a name="Wordnik-delete_word_list"><strong>delete_word_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Deletes an existing WordList<br>
/wordList.{format}/{wordListId}<br>
<br>
Path Parameters:<br>
wordListId</tt></dd></dl>
<dl><dt><a name="Wordnik-get_account_api_token_status"><strong>get_account_api_token_status</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns usage statistics for the API account.<br>
/account.{format}/apiTokenStatus<br>
<br>
Other Parameters:<br>
api_key</tt></dd></dl>
<dl><dt><a name="Wordnik-get_account_authenticate"><strong>get_account_authenticate</strong></a>(self, *args, **kwargs)</dt><dd><tt>Authenticates a User<br>
/account.{format}/authenticate/{username}<br>
<br>
Path Parameters:<br>
username<br>
<br>
Other Parameters:<br>
password</tt></dd></dl>
<dl><dt><a name="Wordnik-get_account_regenerate_api_token"><strong>get_account_regenerate_api_token</strong></a>(self, *args, **kwargs)</dt><dd><tt>Regenerates an API Token. Currently not supported or tested.<br>
/account.{format}/regenerateApiToken<br>
<br>
Other Parameters:<br>
api_key</tt></dd></dl>
<dl><dt><a name="Wordnik-get_account_user"><strong>get_account_user</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns the logged-in User<br>
/account.{format}/user<br>
<br>
Other Parameters:<br>
auth_token</tt></dd></dl>
<dl><dt><a name="Wordnik-get_account_username_available"><strong>get_account_username_available</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns an ApiResponse indicating whether or not a username is available<br>
/account.{format}/usernameAvailable/{username}<br>
<br>
Path Parameters:<br>
username</tt></dd></dl>
<dl><dt><a name="Wordnik-get_user_word_of_the_day"><strong>get_user_word_of_the_day</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns the WordOfTheDay for a given user on a given date<br>
/user.{format}/{username}/wordOfTheDay/{date}<br>
<br>
Path Parameters:<br>
username<br>
date<br>
<br>
Other Parameters:<br>
includeAll</tt></dd></dl>
<dl><dt><a name="Wordnik-get_user_word_of_the_day_list"><strong>get_user_word_of_the_day_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns a user's WordOfTheDayList<br>
/user.{format}/{username}/wordOfTheDayList<br>
<br>
Path Parameters:<br>
username<br>
<br>
Other Parameters:<br>
includeAll</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word"><strong>get_word</strong></a>(self, *args, **kwargs)</dt><dd><tt>Given a word as a string, returns the WordObject that represents it<br>
/word.{format}/{word}<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical<br>
includeSuggestions</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_audio"><strong>get_word_audio</strong></a>(self, *args, **kwargs)</dt><dd><tt>Fetches audio metadata for a word.<br>
/word.{format}/{word}/audio<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_definitions"><strong>get_word_definitions</strong></a>(self, *args, **kwargs)</dt><dd><tt>Return definitions for a word<br>
/word.{format}/{word}/definitions<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
limit<br>
partOfSpeech<br>
includeRelated<br>
sourceDictionaries<br>
useCanonical<br>
includeTags</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_examples"><strong>get_word_examples</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns examples for a word<br>
/word.{format}/{word}/examples<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
limit<br>
includeDuplicates<br>
contentProvider<br>
useCanonical<br>
skip</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_frequency"><strong>get_word_frequency</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns word usage over time<br>
/word.{format}/{word}/frequency<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical<br>
startYear<br>
endYear</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_hyphenation"><strong>get_word_hyphenation</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns syllable information for a word<br>
/word.{format}/{word}/hyphenation<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical<br>
sourceDictionary<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_list"><strong>get_word_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Fetches a WordList by ID<br>
/wordList.{format}/{wordListId}<br>
<br>
Path Parameters:<br>
wordListId</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_list_words"><strong>get_word_list_words</strong></a>(self, *args, **kwargs)</dt><dd><tt>Fetches words in a WordList<br>
/wordList.{format}/{wordListId}/words<br>
<br>
Path Parameters:<br>
wordListId<br>
<br>
Other Parameters:<br>
sortBy<br>
sortOrder<br>
skip<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_lists"><strong>get_word_lists</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns information about API parameters<br>
/wordLists</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_phrases"><strong>get_word_phrases</strong></a>(self, *args, **kwargs)</dt><dd><tt>Fetches bi-gram phrases for a word<br>
/word.{format}/{word}/phrases<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
limit<br>
wlmi<br>
useCanonical</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_pronunciations"><strong>get_word_pronunciations</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns text pronunciations for a given word<br>
/word.{format}/{word}/pronunciations<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical<br>
sourceDictionary<br>
typeFormat<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_related"><strong>get_word_related</strong></a>(self, *args, **kwargs)</dt><dd><tt>Return related words (thesaurus data) for a word<br>
/word.{format}/{word}/related<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
partOfSpeech<br>
sourceDictionary<br>
limit<br>
useCanonical<br>
type</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_top_example"><strong>get_word_top_example</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns a top example for a word<br>
/word.{format}/{word}/topExample<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
contentProvider<br>
useCanonical</tt></dd></dl>
<dl><dt><a name="Wordnik-get_word_word_forms"><strong>get_word_word_forms</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns other forms of a word<br>
/word.{format}/{word}/wordForms<br>
<br>
Path Parameters:<br>
word<br>
<br>
Other Parameters:<br>
useCanonical</tt></dd></dl>
<dl><dt><a name="Wordnik-get_words_random_word"><strong>get_words_random_word</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns a single random WordObject, in the format specified by the URL<br>
/words.{format}/randomWord<br>
<br>
Other Parameters:<br>
hasDictionaryDef<br>
includePartOfSpeech<br>
excludePartOfSpeech<br>
minCorpusCount<br>
maxCorpusCount<br>
minDictionaryCount<br>
maxDictionaryCount<br>
minLength<br>
maxLength</tt></dd></dl>
<dl><dt><a name="Wordnik-get_words_random_words"><strong>get_words_random_words</strong></a>(self, *args, **kwargs)</dt><dd><tt>Returns an array of random WordObjects, in the format specified by the URL<br>
/words.{format}/randomWords<br>
<br>
Other Parameters:<br>
hasDictionaryDef<br>
includePartOfSpeech<br>
excludePartOfSpeech<br>
minCorpusCount<br>
maxCorpusCount<br>
minDictionaryCount<br>
maxDictionaryCount<br>
minLength<br>
maxLength<br>
sortBy<br>
sortOrder<br>
skip<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_words_search"><strong>get_words_search</strong></a>(self, *args, **kwargs)</dt><dd><tt>Searches words.<br>
/words.{format}/search<br>
<br>
Other Parameters:<br>
query<br>
caseSensitive<br>
includePartOfSpeech<br>
excludePartOfSpeech<br>
minCorpusCount<br>
maxCorpusCount<br>
minDictionaryCount<br>
maxDictionaryCount<br>
minLength<br>
maxLength<br>
skip<br>
limit</tt></dd></dl>
<dl><dt><a name="Wordnik-get_words_word_of_the_day_lists"><strong>get_words_word_of_the_day_lists</strong></a>(self, *args, **kwargs)</dt><dd><tt>Fetches WordOfTheDay objects for a specific date<br>
/words.{format}/wordOfTheDayLists/{date}<br>
<br>
Path Parameters:<br>
date<br>
<br>
Other Parameters:<br>
includeAll</tt></dd></dl>
<dl><dt><a name="Wordnik-multi"><strong>multi</strong></a>(self, calls, **kwargs)</dt><dd><tt>Multiple calls, batched. This is a "special case" method<br>
in that it's not automatically generated from the API documentation.<br>
That's because, well, it's undocumented. Here's how you use it:<br>
<br>
Wordnik.<a href="#wordnik.Wordnik-multi">multi</a>( [call1, call2, call3 ], **kwargs)<br>
<br>
where each "call" is (word, resource, {param1: value1, ...} )<br>
So we could form a batch call like so:<br>
<br>
calls = [("dog","examples"),("cat","definitions",{"limit":500})]<br>
<br>
Wordnik.<a href="#wordnik.Wordnik-multi">multi</a>(calls, format="xml")</tt></dd></dl>
<dl><dt><a name="Wordnik-post_account_authenticate"><strong>post_account_authenticate</strong></a>(self, *args, **kwargs)</dt><dd><tt>Authenticates a user<br>
/account.{format}/authenticate/{username}<br>
<br>
Path Parameters:<br>
username<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-post_user_word_of_the_day_list"><strong>post_user_word_of_the_day_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Creates a WordOfTheDayList<br>
/user.{format}/{username}/wordOfTheDayList<br>
<br>
Path Parameters:<br>
username<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-post_word_list_delete_words"><strong>post_word_list_delete_words</strong></a>(self, *args, **kwargs)</dt><dd><tt>Removes words from a WordList<br>
/wordList.{format}/{wordListId}/deleteWords<br>
<br>
Path Parameters:<br>
wordListId<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-post_word_list_words"><strong>post_word_list_words</strong></a>(self, *args, **kwargs)</dt><dd><tt>Adds words to a WordList<br>
/wordList.{format}/{wordListId}/words<br>
<br>
Path Parameters:<br>
wordListId<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-post_word_lists"><strong>post_word_lists</strong></a>(self, *args, **kwargs)</dt><dd><tt>Creates a WordList.<br>
/wordLists<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-post_words_word_of_the_day_list_subscription"><strong>post_words_word_of_the_day_list_subscription</strong></a>(self, *args, **kwargs)</dt><dd><tt>Subscribes a user to a WordOfTheDayList<br>
/words.{format}/wordOfTheDayList/{permalink}/subscription<br>
<br>
Path Parameters:<br>
permalink<br>
<br>
Other Parameters:<br>
auth_token<br>
medium<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-put_user_word_of_the_day_list"><strong>put_user_word_of_the_day_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Adds a WordOfTheDay to a user's WordOfTheDayList<br>
/user.{format}/{username}/wordOfTheDayList/{permalink}<br>
<br>
Path Parameters:<br>
username<br>
permalink<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-put_user_word_of_the_day_list_add"><strong>put_user_word_of_the_day_list_add</strong></a>(self, *args, **kwargs)</dt><dd><tt>Adds an item to a user's WordOfTheDayList<br>
/user.{format}/{username}/wordOfTheDayList/{permalink}/add<br>
<br>
Path Parameters:<br>
username<br>
permalink<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<dl><dt><a name="Wordnik-put_word_list"><strong>put_word_list</strong></a>(self, *args, **kwargs)</dt><dd><tt>Updates an existing WordList<br>
/wordList.{format}/{wordListId}<br>
<br>
Path Parameters:<br>
wordListId<br>
<br>
Other Parameters:<br>
body</tt></dd></dl>
<hr>
Data descriptors defined here:<br>
<dl><dt><strong>__dict__</strong></dt>
<dd><tt>dictionary for instance variables (if defined)</tt></dd>
</dl>
<dl><dt><strong>__weakref__</strong></dt>
<dd><tt>list of weak references to the object (if defined)</tt></dd>
</dl>
</td></tr></table>
</body></html>