webscout 8.2.9__py3-none-any.whl → 2026.1.19__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (413) hide show
  1. webscout/AIauto.py +524 -251
  2. webscout/AIbase.py +247 -319
  3. webscout/AIutel.py +68 -703
  4. webscout/Bard.py +1072 -1026
  5. webscout/Extra/GitToolkit/__init__.py +10 -10
  6. webscout/Extra/GitToolkit/gitapi/__init__.py +20 -12
  7. webscout/Extra/GitToolkit/gitapi/gist.py +142 -0
  8. webscout/Extra/GitToolkit/gitapi/organization.py +91 -0
  9. webscout/Extra/GitToolkit/gitapi/repository.py +308 -195
  10. webscout/Extra/GitToolkit/gitapi/search.py +162 -0
  11. webscout/Extra/GitToolkit/gitapi/trending.py +236 -0
  12. webscout/Extra/GitToolkit/gitapi/user.py +128 -96
  13. webscout/Extra/GitToolkit/gitapi/utils.py +82 -62
  14. webscout/Extra/YTToolkit/README.md +443 -375
  15. webscout/Extra/YTToolkit/YTdownloader.py +953 -957
  16. webscout/Extra/YTToolkit/__init__.py +3 -3
  17. webscout/Extra/YTToolkit/transcriber.py +595 -476
  18. webscout/Extra/YTToolkit/ytapi/README.md +230 -44
  19. webscout/Extra/YTToolkit/ytapi/__init__.py +22 -6
  20. webscout/Extra/YTToolkit/ytapi/captions.py +190 -0
  21. webscout/Extra/YTToolkit/ytapi/channel.py +302 -307
  22. webscout/Extra/YTToolkit/ytapi/errors.py +13 -13
  23. webscout/Extra/YTToolkit/ytapi/extras.py +178 -118
  24. webscout/Extra/YTToolkit/ytapi/hashtag.py +120 -0
  25. webscout/Extra/YTToolkit/ytapi/https.py +89 -88
  26. webscout/Extra/YTToolkit/ytapi/patterns.py +61 -61
  27. webscout/Extra/YTToolkit/ytapi/playlist.py +59 -59
  28. webscout/Extra/YTToolkit/ytapi/pool.py +8 -8
  29. webscout/Extra/YTToolkit/ytapi/query.py +143 -40
  30. webscout/Extra/YTToolkit/ytapi/shorts.py +122 -0
  31. webscout/Extra/YTToolkit/ytapi/stream.py +68 -63
  32. webscout/Extra/YTToolkit/ytapi/suggestions.py +97 -0
  33. webscout/Extra/YTToolkit/ytapi/utils.py +66 -62
  34. webscout/Extra/YTToolkit/ytapi/video.py +403 -232
  35. webscout/Extra/__init__.py +2 -3
  36. webscout/Extra/gguf.py +1298 -684
  37. webscout/Extra/tempmail/README.md +487 -487
  38. webscout/Extra/tempmail/__init__.py +28 -28
  39. webscout/Extra/tempmail/async_utils.py +143 -141
  40. webscout/Extra/tempmail/base.py +172 -161
  41. webscout/Extra/tempmail/cli.py +191 -187
  42. webscout/Extra/tempmail/emailnator.py +88 -84
  43. webscout/Extra/tempmail/mail_tm.py +378 -361
  44. webscout/Extra/tempmail/temp_mail_io.py +304 -292
  45. webscout/Extra/weather.py +196 -194
  46. webscout/Extra/weather_ascii.py +17 -15
  47. webscout/Provider/AISEARCH/PERPLEXED_search.py +175 -0
  48. webscout/Provider/AISEARCH/Perplexity.py +292 -333
  49. webscout/Provider/AISEARCH/README.md +106 -279
  50. webscout/Provider/AISEARCH/__init__.py +16 -9
  51. webscout/Provider/AISEARCH/brave_search.py +298 -0
  52. webscout/Provider/AISEARCH/iask_search.py +357 -410
  53. webscout/Provider/AISEARCH/monica_search.py +200 -220
  54. webscout/Provider/AISEARCH/webpilotai_search.py +242 -255
  55. webscout/Provider/Algion.py +413 -0
  56. webscout/Provider/Andi.py +74 -69
  57. webscout/Provider/Apriel.py +313 -0
  58. webscout/Provider/Ayle.py +323 -0
  59. webscout/Provider/ChatSandbox.py +329 -342
  60. webscout/Provider/ClaudeOnline.py +365 -0
  61. webscout/Provider/Cohere.py +232 -208
  62. webscout/Provider/DeepAI.py +367 -0
  63. webscout/Provider/Deepinfra.py +467 -340
  64. webscout/Provider/EssentialAI.py +217 -0
  65. webscout/Provider/ExaAI.py +274 -261
  66. webscout/Provider/Gemini.py +175 -169
  67. webscout/Provider/GithubChat.py +385 -369
  68. webscout/Provider/Gradient.py +286 -0
  69. webscout/Provider/Groq.py +556 -801
  70. webscout/Provider/HadadXYZ.py +323 -0
  71. webscout/Provider/HeckAI.py +392 -375
  72. webscout/Provider/HuggingFace.py +387 -0
  73. webscout/Provider/IBM.py +340 -0
  74. webscout/Provider/Jadve.py +317 -291
  75. webscout/Provider/K2Think.py +306 -0
  76. webscout/Provider/Koboldai.py +221 -384
  77. webscout/Provider/Netwrck.py +273 -270
  78. webscout/Provider/Nvidia.py +310 -0
  79. webscout/Provider/OPENAI/DeepAI.py +489 -0
  80. webscout/Provider/OPENAI/K2Think.py +423 -0
  81. webscout/Provider/OPENAI/PI.py +463 -0
  82. webscout/Provider/OPENAI/README.md +890 -952
  83. webscout/Provider/OPENAI/TogetherAI.py +405 -0
  84. webscout/Provider/OPENAI/TwoAI.py +255 -357
  85. webscout/Provider/OPENAI/__init__.py +148 -40
  86. webscout/Provider/OPENAI/ai4chat.py +348 -293
  87. webscout/Provider/OPENAI/akashgpt.py +436 -0
  88. webscout/Provider/OPENAI/algion.py +303 -0
  89. webscout/Provider/OPENAI/{exachat.py → ayle.py} +365 -444
  90. webscout/Provider/OPENAI/base.py +253 -249
  91. webscout/Provider/OPENAI/cerebras.py +296 -0
  92. webscout/Provider/OPENAI/chatgpt.py +870 -556
  93. webscout/Provider/OPENAI/chatsandbox.py +233 -173
  94. webscout/Provider/OPENAI/deepinfra.py +403 -322
  95. webscout/Provider/OPENAI/e2b.py +2370 -1414
  96. webscout/Provider/OPENAI/elmo.py +278 -0
  97. webscout/Provider/OPENAI/exaai.py +452 -417
  98. webscout/Provider/OPENAI/freeassist.py +446 -0
  99. webscout/Provider/OPENAI/gradient.py +448 -0
  100. webscout/Provider/OPENAI/groq.py +380 -364
  101. webscout/Provider/OPENAI/hadadxyz.py +292 -0
  102. webscout/Provider/OPENAI/heckai.py +333 -308
  103. webscout/Provider/OPENAI/huggingface.py +321 -0
  104. webscout/Provider/OPENAI/ibm.py +425 -0
  105. webscout/Provider/OPENAI/llmchat.py +253 -0
  106. webscout/Provider/OPENAI/llmchatco.py +378 -335
  107. webscout/Provider/OPENAI/meta.py +541 -0
  108. webscout/Provider/OPENAI/netwrck.py +374 -357
  109. webscout/Provider/OPENAI/nvidia.py +317 -0
  110. webscout/Provider/OPENAI/oivscode.py +348 -287
  111. webscout/Provider/OPENAI/openrouter.py +328 -0
  112. webscout/Provider/OPENAI/pydantic_imports.py +1 -172
  113. webscout/Provider/OPENAI/sambanova.py +397 -0
  114. webscout/Provider/OPENAI/sonus.py +305 -304
  115. webscout/Provider/OPENAI/textpollinations.py +370 -339
  116. webscout/Provider/OPENAI/toolbaz.py +375 -413
  117. webscout/Provider/OPENAI/typefully.py +419 -355
  118. webscout/Provider/OPENAI/typliai.py +279 -0
  119. webscout/Provider/OPENAI/utils.py +314 -318
  120. webscout/Provider/OPENAI/wisecat.py +359 -387
  121. webscout/Provider/OPENAI/writecream.py +185 -163
  122. webscout/Provider/OPENAI/x0gpt.py +462 -365
  123. webscout/Provider/OPENAI/zenmux.py +380 -0
  124. webscout/Provider/OpenRouter.py +386 -0
  125. webscout/Provider/Openai.py +337 -496
  126. webscout/Provider/PI.py +443 -429
  127. webscout/Provider/QwenLM.py +346 -254
  128. webscout/Provider/STT/__init__.py +28 -0
  129. webscout/Provider/STT/base.py +303 -0
  130. webscout/Provider/STT/elevenlabs.py +264 -0
  131. webscout/Provider/Sambanova.py +317 -0
  132. webscout/Provider/TTI/README.md +69 -82
  133. webscout/Provider/TTI/__init__.py +37 -7
  134. webscout/Provider/TTI/base.py +147 -64
  135. webscout/Provider/TTI/claudeonline.py +393 -0
  136. webscout/Provider/TTI/magicstudio.py +292 -201
  137. webscout/Provider/TTI/miragic.py +180 -0
  138. webscout/Provider/TTI/pollinations.py +331 -221
  139. webscout/Provider/TTI/together.py +334 -0
  140. webscout/Provider/TTI/utils.py +14 -11
  141. webscout/Provider/TTS/README.md +186 -192
  142. webscout/Provider/TTS/__init__.py +43 -10
  143. webscout/Provider/TTS/base.py +523 -159
  144. webscout/Provider/TTS/deepgram.py +286 -156
  145. webscout/Provider/TTS/elevenlabs.py +189 -111
  146. webscout/Provider/TTS/freetts.py +218 -0
  147. webscout/Provider/TTS/murfai.py +288 -113
  148. webscout/Provider/TTS/openai_fm.py +364 -129
  149. webscout/Provider/TTS/parler.py +203 -111
  150. webscout/Provider/TTS/qwen.py +334 -0
  151. webscout/Provider/TTS/sherpa.py +286 -0
  152. webscout/Provider/TTS/speechma.py +693 -580
  153. webscout/Provider/TTS/streamElements.py +275 -333
  154. webscout/Provider/TTS/utils.py +280 -280
  155. webscout/Provider/TextPollinationsAI.py +331 -308
  156. webscout/Provider/TogetherAI.py +450 -0
  157. webscout/Provider/TwoAI.py +309 -475
  158. webscout/Provider/TypliAI.py +311 -305
  159. webscout/Provider/UNFINISHED/ChatHub.py +219 -209
  160. webscout/Provider/{OPENAI/glider.py → UNFINISHED/ChutesAI.py} +331 -326
  161. webscout/Provider/{GizAI.py → UNFINISHED/GizAI.py} +300 -295
  162. webscout/Provider/{Marcus.py → UNFINISHED/Marcus.py} +218 -198
  163. webscout/Provider/UNFINISHED/Qodo.py +481 -0
  164. webscout/Provider/{MCPCore.py → UNFINISHED/XenAI.py} +330 -315
  165. webscout/Provider/UNFINISHED/Youchat.py +347 -330
  166. webscout/Provider/UNFINISHED/aihumanizer.py +41 -0
  167. webscout/Provider/UNFINISHED/grammerchecker.py +37 -0
  168. webscout/Provider/UNFINISHED/liner.py +342 -0
  169. webscout/Provider/UNFINISHED/liner_api_request.py +246 -263
  170. webscout/Provider/{samurai.py → UNFINISHED/samurai.py} +231 -224
  171. webscout/Provider/WiseCat.py +256 -233
  172. webscout/Provider/WrDoChat.py +390 -370
  173. webscout/Provider/__init__.py +115 -174
  174. webscout/Provider/ai4chat.py +181 -174
  175. webscout/Provider/akashgpt.py +330 -335
  176. webscout/Provider/cerebras.py +397 -290
  177. webscout/Provider/cleeai.py +236 -213
  178. webscout/Provider/elmo.py +291 -283
  179. webscout/Provider/geminiapi.py +343 -208
  180. webscout/Provider/julius.py +245 -223
  181. webscout/Provider/learnfastai.py +333 -325
  182. webscout/Provider/llama3mitril.py +230 -215
  183. webscout/Provider/llmchat.py +308 -258
  184. webscout/Provider/llmchatco.py +321 -306
  185. webscout/Provider/meta.py +996 -801
  186. webscout/Provider/oivscode.py +332 -309
  187. webscout/Provider/searchchat.py +316 -292
  188. webscout/Provider/sonus.py +264 -258
  189. webscout/Provider/toolbaz.py +359 -353
  190. webscout/Provider/turboseek.py +332 -266
  191. webscout/Provider/typefully.py +262 -202
  192. webscout/Provider/x0gpt.py +332 -299
  193. webscout/__init__.py +31 -39
  194. webscout/__main__.py +5 -5
  195. webscout/cli.py +585 -524
  196. webscout/client.py +1497 -70
  197. webscout/conversation.py +140 -436
  198. webscout/exceptions.py +383 -362
  199. webscout/litagent/__init__.py +29 -29
  200. webscout/litagent/agent.py +492 -455
  201. webscout/litagent/constants.py +60 -60
  202. webscout/models.py +505 -181
  203. webscout/optimizers.py +74 -420
  204. webscout/prompt_manager.py +376 -288
  205. webscout/sanitize.py +1514 -0
  206. webscout/scout/README.md +452 -404
  207. webscout/scout/__init__.py +8 -8
  208. webscout/scout/core/__init__.py +7 -7
  209. webscout/scout/core/crawler.py +330 -210
  210. webscout/scout/core/scout.py +800 -607
  211. webscout/scout/core/search_result.py +51 -96
  212. webscout/scout/core/text_analyzer.py +64 -63
  213. webscout/scout/core/text_utils.py +412 -277
  214. webscout/scout/core/web_analyzer.py +54 -52
  215. webscout/scout/element.py +872 -478
  216. webscout/scout/parsers/__init__.py +70 -69
  217. webscout/scout/parsers/html5lib_parser.py +182 -172
  218. webscout/scout/parsers/html_parser.py +238 -236
  219. webscout/scout/parsers/lxml_parser.py +203 -178
  220. webscout/scout/utils.py +38 -37
  221. webscout/search/__init__.py +47 -0
  222. webscout/search/base.py +201 -0
  223. webscout/search/bing_main.py +45 -0
  224. webscout/search/brave_main.py +92 -0
  225. webscout/search/duckduckgo_main.py +57 -0
  226. webscout/search/engines/__init__.py +127 -0
  227. webscout/search/engines/bing/__init__.py +15 -0
  228. webscout/search/engines/bing/base.py +35 -0
  229. webscout/search/engines/bing/images.py +114 -0
  230. webscout/search/engines/bing/news.py +96 -0
  231. webscout/search/engines/bing/suggestions.py +36 -0
  232. webscout/search/engines/bing/text.py +109 -0
  233. webscout/search/engines/brave/__init__.py +19 -0
  234. webscout/search/engines/brave/base.py +47 -0
  235. webscout/search/engines/brave/images.py +213 -0
  236. webscout/search/engines/brave/news.py +353 -0
  237. webscout/search/engines/brave/suggestions.py +318 -0
  238. webscout/search/engines/brave/text.py +167 -0
  239. webscout/search/engines/brave/videos.py +364 -0
  240. webscout/search/engines/duckduckgo/__init__.py +25 -0
  241. webscout/search/engines/duckduckgo/answers.py +80 -0
  242. webscout/search/engines/duckduckgo/base.py +189 -0
  243. webscout/search/engines/duckduckgo/images.py +100 -0
  244. webscout/search/engines/duckduckgo/maps.py +183 -0
  245. webscout/search/engines/duckduckgo/news.py +70 -0
  246. webscout/search/engines/duckduckgo/suggestions.py +22 -0
  247. webscout/search/engines/duckduckgo/text.py +221 -0
  248. webscout/search/engines/duckduckgo/translate.py +48 -0
  249. webscout/search/engines/duckduckgo/videos.py +80 -0
  250. webscout/search/engines/duckduckgo/weather.py +84 -0
  251. webscout/search/engines/mojeek.py +61 -0
  252. webscout/search/engines/wikipedia.py +77 -0
  253. webscout/search/engines/yahoo/__init__.py +41 -0
  254. webscout/search/engines/yahoo/answers.py +19 -0
  255. webscout/search/engines/yahoo/base.py +34 -0
  256. webscout/search/engines/yahoo/images.py +323 -0
  257. webscout/search/engines/yahoo/maps.py +19 -0
  258. webscout/search/engines/yahoo/news.py +258 -0
  259. webscout/search/engines/yahoo/suggestions.py +140 -0
  260. webscout/search/engines/yahoo/text.py +273 -0
  261. webscout/search/engines/yahoo/translate.py +19 -0
  262. webscout/search/engines/yahoo/videos.py +302 -0
  263. webscout/search/engines/yahoo/weather.py +220 -0
  264. webscout/search/engines/yandex.py +67 -0
  265. webscout/search/engines/yep/__init__.py +13 -0
  266. webscout/search/engines/yep/base.py +34 -0
  267. webscout/search/engines/yep/images.py +101 -0
  268. webscout/search/engines/yep/suggestions.py +38 -0
  269. webscout/search/engines/yep/text.py +99 -0
  270. webscout/search/http_client.py +172 -0
  271. webscout/search/results.py +141 -0
  272. webscout/search/yahoo_main.py +57 -0
  273. webscout/search/yep_main.py +48 -0
  274. webscout/server/__init__.py +48 -0
  275. webscout/server/config.py +78 -0
  276. webscout/server/exceptions.py +69 -0
  277. webscout/server/providers.py +286 -0
  278. webscout/server/request_models.py +131 -0
  279. webscout/server/request_processing.py +404 -0
  280. webscout/server/routes.py +642 -0
  281. webscout/server/server.py +351 -0
  282. webscout/server/ui_templates.py +1171 -0
  283. webscout/swiftcli/__init__.py +79 -95
  284. webscout/swiftcli/core/__init__.py +7 -7
  285. webscout/swiftcli/core/cli.py +574 -297
  286. webscout/swiftcli/core/context.py +98 -104
  287. webscout/swiftcli/core/group.py +268 -241
  288. webscout/swiftcli/decorators/__init__.py +28 -28
  289. webscout/swiftcli/decorators/command.py +243 -221
  290. webscout/swiftcli/decorators/options.py +247 -220
  291. webscout/swiftcli/decorators/output.py +392 -252
  292. webscout/swiftcli/exceptions.py +21 -21
  293. webscout/swiftcli/plugins/__init__.py +9 -9
  294. webscout/swiftcli/plugins/base.py +134 -135
  295. webscout/swiftcli/plugins/manager.py +269 -269
  296. webscout/swiftcli/utils/__init__.py +58 -59
  297. webscout/swiftcli/utils/formatting.py +251 -252
  298. webscout/swiftcli/utils/parsing.py +368 -267
  299. webscout/update_checker.py +280 -136
  300. webscout/utils.py +28 -14
  301. webscout/version.py +2 -1
  302. webscout/version.py.bak +3 -0
  303. webscout/zeroart/__init__.py +218 -135
  304. webscout/zeroart/base.py +70 -66
  305. webscout/zeroart/effects.py +155 -101
  306. webscout/zeroart/fonts.py +1799 -1239
  307. webscout-2026.1.19.dist-info/METADATA +638 -0
  308. webscout-2026.1.19.dist-info/RECORD +312 -0
  309. {webscout-8.2.9.dist-info → webscout-2026.1.19.dist-info}/WHEEL +1 -1
  310. {webscout-8.2.9.dist-info → webscout-2026.1.19.dist-info}/entry_points.txt +1 -1
  311. webscout/DWEBS.py +0 -520
  312. webscout/Extra/Act.md +0 -309
  313. webscout/Extra/GitToolkit/gitapi/README.md +0 -110
  314. webscout/Extra/autocoder/__init__.py +0 -9
  315. webscout/Extra/autocoder/autocoder.py +0 -1105
  316. webscout/Extra/autocoder/autocoder_utiles.py +0 -332
  317. webscout/Extra/gguf.md +0 -430
  318. webscout/Extra/weather.md +0 -281
  319. webscout/Litlogger/README.md +0 -10
  320. webscout/Litlogger/__init__.py +0 -15
  321. webscout/Litlogger/formats.py +0 -4
  322. webscout/Litlogger/handlers.py +0 -103
  323. webscout/Litlogger/levels.py +0 -13
  324. webscout/Litlogger/logger.py +0 -92
  325. webscout/Provider/AI21.py +0 -177
  326. webscout/Provider/AISEARCH/DeepFind.py +0 -254
  327. webscout/Provider/AISEARCH/felo_search.py +0 -202
  328. webscout/Provider/AISEARCH/genspark_search.py +0 -324
  329. webscout/Provider/AISEARCH/hika_search.py +0 -186
  330. webscout/Provider/AISEARCH/scira_search.py +0 -298
  331. webscout/Provider/Aitopia.py +0 -316
  332. webscout/Provider/AllenAI.py +0 -440
  333. webscout/Provider/Blackboxai.py +0 -791
  334. webscout/Provider/ChatGPTClone.py +0 -237
  335. webscout/Provider/ChatGPTGratis.py +0 -194
  336. webscout/Provider/Cloudflare.py +0 -324
  337. webscout/Provider/ExaChat.py +0 -358
  338. webscout/Provider/Flowith.py +0 -217
  339. webscout/Provider/FreeGemini.py +0 -250
  340. webscout/Provider/Glider.py +0 -225
  341. webscout/Provider/HF_space/__init__.py +0 -0
  342. webscout/Provider/HF_space/qwen_qwen2.py +0 -206
  343. webscout/Provider/HuggingFaceChat.py +0 -469
  344. webscout/Provider/Hunyuan.py +0 -283
  345. webscout/Provider/LambdaChat.py +0 -411
  346. webscout/Provider/Llama3.py +0 -259
  347. webscout/Provider/Nemotron.py +0 -218
  348. webscout/Provider/OLLAMA.py +0 -396
  349. webscout/Provider/OPENAI/BLACKBOXAI.py +0 -766
  350. webscout/Provider/OPENAI/Cloudflare.py +0 -378
  351. webscout/Provider/OPENAI/FreeGemini.py +0 -283
  352. webscout/Provider/OPENAI/NEMOTRON.py +0 -232
  353. webscout/Provider/OPENAI/Qwen3.py +0 -283
  354. webscout/Provider/OPENAI/api.py +0 -969
  355. webscout/Provider/OPENAI/c4ai.py +0 -373
  356. webscout/Provider/OPENAI/chatgptclone.py +0 -494
  357. webscout/Provider/OPENAI/copilot.py +0 -242
  358. webscout/Provider/OPENAI/flowith.py +0 -162
  359. webscout/Provider/OPENAI/freeaichat.py +0 -359
  360. webscout/Provider/OPENAI/mcpcore.py +0 -389
  361. webscout/Provider/OPENAI/multichat.py +0 -376
  362. webscout/Provider/OPENAI/opkfc.py +0 -496
  363. webscout/Provider/OPENAI/scirachat.py +0 -477
  364. webscout/Provider/OPENAI/standardinput.py +0 -433
  365. webscout/Provider/OPENAI/typegpt.py +0 -364
  366. webscout/Provider/OPENAI/uncovrAI.py +0 -463
  367. webscout/Provider/OPENAI/venice.py +0 -431
  368. webscout/Provider/OPENAI/yep.py +0 -382
  369. webscout/Provider/OpenGPT.py +0 -209
  370. webscout/Provider/Perplexitylabs.py +0 -415
  371. webscout/Provider/Reka.py +0 -214
  372. webscout/Provider/StandardInput.py +0 -290
  373. webscout/Provider/TTI/aiarta.py +0 -365
  374. webscout/Provider/TTI/artbit.py +0 -0
  375. webscout/Provider/TTI/fastflux.py +0 -200
  376. webscout/Provider/TTI/piclumen.py +0 -203
  377. webscout/Provider/TTI/pixelmuse.py +0 -225
  378. webscout/Provider/TTS/gesserit.py +0 -128
  379. webscout/Provider/TTS/sthir.py +0 -94
  380. webscout/Provider/TeachAnything.py +0 -229
  381. webscout/Provider/UNFINISHED/puterjs.py +0 -635
  382. webscout/Provider/UNFINISHED/test_lmarena.py +0 -119
  383. webscout/Provider/Venice.py +0 -258
  384. webscout/Provider/VercelAI.py +0 -253
  385. webscout/Provider/Writecream.py +0 -246
  386. webscout/Provider/WritingMate.py +0 -269
  387. webscout/Provider/asksteve.py +0 -220
  388. webscout/Provider/chatglm.py +0 -215
  389. webscout/Provider/copilot.py +0 -425
  390. webscout/Provider/freeaichat.py +0 -285
  391. webscout/Provider/granite.py +0 -235
  392. webscout/Provider/hermes.py +0 -266
  393. webscout/Provider/koala.py +0 -170
  394. webscout/Provider/lmarena.py +0 -198
  395. webscout/Provider/multichat.py +0 -364
  396. webscout/Provider/scira_chat.py +0 -299
  397. webscout/Provider/scnet.py +0 -243
  398. webscout/Provider/talkai.py +0 -194
  399. webscout/Provider/typegpt.py +0 -289
  400. webscout/Provider/uncovr.py +0 -368
  401. webscout/Provider/yep.py +0 -389
  402. webscout/litagent/Readme.md +0 -276
  403. webscout/litprinter/__init__.py +0 -59
  404. webscout/swiftcli/Readme.md +0 -323
  405. webscout/tempid.py +0 -128
  406. webscout/webscout_search.py +0 -1184
  407. webscout/webscout_search_async.py +0 -654
  408. webscout/yep_search.py +0 -347
  409. webscout/zeroart/README.md +0 -89
  410. webscout-8.2.9.dist-info/METADATA +0 -1033
  411. webscout-8.2.9.dist-info/RECORD +0 -289
  412. {webscout-8.2.9.dist-info → webscout-2026.1.19.dist-info}/licenses/LICENSE.md +0 -0
  413. {webscout-8.2.9.dist-info → webscout-2026.1.19.dist-info}/top_level.txt +0 -0
@@ -1,488 +1,488 @@
1
- <div align="center">
2
- <a href="https://github.com/OEvortex/Webscout">
3
- <img src="https://img.shields.io/badge/WebScout-TempMail%20Module-blue?style=for-the-badge&logo=mail&logoColor=white" alt="WebScout TempMail">
4
- </a>
5
-
6
- <h1>📧 TempMail</h1>
7
-
8
- <p><strong>Powerful Temporary Email Generation & Management</strong></p>
9
-
10
- <p>
11
- Create disposable email addresses, manage messages, and automate email verification workflows with multiple providers and both synchronous and asynchronous APIs.
12
- </p>
13
-
14
- <!-- Badges -->
15
- <p>
16
- <a href="https://pypi.org/project/webscout/"><img src="https://img.shields.io/pypi/v/webscout.svg?style=flat-square&logo=pypi&label=PyPI" alt="PyPI Version"></a>
17
- <a href="#"><img src="https://img.shields.io/badge/No%20API%20Key-Required-success?style=flat-square" alt="No API Key Required"></a>
18
- <a href="#"><img src="https://img.shields.io/badge/Python-3.7%2B-blue?style=flat-square&logo=python" alt="Python Version"></a>
19
- </p>
20
- </div>
21
-
22
- > [!NOTE]
23
- > TempMail provides disposable email addresses for testing, verification, and privacy protection. It supports multiple providers and offers both synchronous and asynchronous interfaces.
24
-
25
- ## ✨ Key Features
26
-
27
- ### Email Management
28
-
29
- * **Multiple Provider Support**
30
- * Native integration with Mail.TM and TempMail.io services
31
- * Extensible architecture for adding new providers
32
- * Consistent interface across all providers
33
-
34
- * **Privacy Protection**
35
- * Generate disposable email addresses on demand
36
- * Protect your primary inbox from spam
37
- * Automatic cleanup after use
38
-
39
- ### Developer Experience
40
-
41
- * **Dual API Support**
42
- * Synchronous interface for simple scripts
43
- * Asynchronous interface for high-performance applications
44
- * Complete feature parity between both interfaces
45
-
46
- * **Automation Tools**
47
- * Helper utilities for common workflows
48
- * Email verification automation
49
- * Message waiting and processing
50
-
51
- * **Command Line Interface**
52
- * Direct terminal access to all features
53
- * Real-time message monitoring
54
- * Simple and detailed output modes
55
-
56
- ## 🚀 Installation
57
-
58
- Install or update Webscout to get access to the TempMail module:
59
-
60
- ```bash
61
- pip install -U webscout
62
- ```
63
-
64
- ## 🖥️ Usage
65
-
66
- ### Basic Synchronous Example
67
-
68
- ```python
69
- from webscout.Extra.tempmail import get_random_email
70
-
71
- # 1. Create a new temporary email (provider chosen automatically)
72
- email, provider = get_random_email()
73
- print(f"[*] Your temporary email: {email}")
74
- print(f"[*] Provider: {type(provider).__name__}")
75
-
76
- try:
77
- # 2. Check for incoming messages
78
- print("[*] Waiting for messages...")
79
- # Add a small delay or implement a loop if checking immediately
80
- import time
81
- time.sleep(10)
82
-
83
- messages = provider.get_messages()
84
- if not messages:
85
- print("[*] No messages received yet.")
86
- else:
87
- print(f"[*] Received {len(messages)} message(s):")
88
- for i, message in enumerate(messages):
89
- print(f"\n--- Message {i+1} ---")
90
- print(f" From: {message.get('from', 'N/A')}")
91
- print(f" Subject: {message.get('subject', 'N/A')}")
92
- # Optionally print body, be mindful of length
93
- # print(f" Body: {message.get('body', 'N/A')[:100]}...")
94
-
95
- finally:
96
- # 3. Clean up: Delete the account/email when done
97
- print("[*] Deleting temporary email account...")
98
- provider.delete_account() # Adjust based on provider (delete_account or delete_email)
99
- print("[*] Account deleted.")
100
-
101
- ```
102
-
103
- ### Choosing a Specific Provider
104
-
105
- ```python
106
- from webscout.Extra.tempmail import get_provider
107
-
108
- # Use Mail.TM (default if unspecified in get_random_email)
109
- print("[*] Using Mail.TM Provider")
110
- mailtm_provider = get_provider("mailtm")
111
- # MailTM typically uses create_account() which generates email+token
112
- account_info = mailtm_provider.create_account()
113
- print(f"[*] Mail.TM Email: {account_info['address']}")
114
- # ... use mailtm_provider.get_messages(), etc. ...
115
- mailtm_provider.delete_account(account_info['id'], account_info['token']) # Requires ID and Token for deletion
116
- print("[*] Mail.TM account deleted.")
117
-
118
-
119
- # Use TempMail.io
120
- print("\n[*] Using TempMail.io Provider")
121
- tempmailio_provider = get_provider("tempmailio")
122
- # TempMail.io might have a different creation flow (check implementation)
123
- # Assuming it also uses create_account() that returns an email address
124
- email_info = tempmailio_provider.create_account() # Adapt if method/return differs
125
- temp_email_io_addr = email_info # Adjust based on actual return value
126
- print(f"[*] TempMail.io Email: {temp_email_io_addr}")
127
- # ... use tempmailio_provider.get_messages(), etc. ...
128
- tempmailio_provider.delete_account() # Adapt if deletion needs specific info
129
- print("[*] TempMail.io account deleted.")
130
- ```
131
-
132
- ### Asynchronous API Example
133
-
134
- ```python
135
- import asyncio
136
- from webscout.Extra.tempmail import get_provider
137
-
138
- async def manage_temp_email_async():
139
- # 1. Get an async provider instance (e.g., Mail.TM)
140
- provider = get_provider("mailtm", async_provider=True)
141
- await provider.initialize() # Important for async providers
142
- print("[*] Async Provider Initialized (Mail.TM)")
143
-
144
- try:
145
- # 2. Create a new email (async method)
146
- # Note: Method might be create_email or create_account depending on provider
147
- email_data = await provider.create_email() # Adjust if method/return differs
148
- email = email_data['address'] # Adjust based on actual return keys
149
- token = email_data.get('token') # Get token if applicable
150
- email_id = email_data.get('id') # Get ID if applicable
151
- print(f"[*] Your temporary email: {email}")
152
-
153
- # 3. Check for messages (async method)
154
- print("[*] Waiting for messages (async)...")
155
- await asyncio.sleep(15) # Wait a bit for potential incoming mail
156
-
157
- messages = await provider.get_messages()
158
- if not messages:
159
- print("[*] No messages received yet.")
160
- else:
161
- print(f"[*] Received {len(messages)} message(s):")
162
- for i, message in enumerate(messages):
163
- print(f"\n--- Message {i+1} ---")
164
- print(f" From: {message.get('from', 'N/A')}")
165
- print(f" Subject: {message.get('subject', 'N/A')}")
166
-
167
- finally:
168
- # 4. Clean up (async methods)
169
- print("[*] Deleting temporary email (async)...")
170
- # Deletion method and required arguments depend on the provider
171
- if token and email_id:
172
- await provider.delete_email(email_id, token) # Example for MailTM-like
173
- elif hasattr(provider, 'delete_email') and not token and not email_id:
174
- await provider.delete_email(email) # Example if only email needed
175
- else:
176
- print("[!] Could not determine deletion method/parameters. Manual cleanup might be needed.")
177
-
178
- await provider.close() # Close the underlying HTTP client
179
- print("[*] Provider closed.")
180
-
181
- # Run the async function
182
- if __name__ == "__main__":
183
- asyncio.run(manage_temp_email_async())
184
- ```
185
-
186
- ### Command Line Interface (CLI)
187
-
188
- Access temporary email features directly from your terminal:
189
-
190
- ```bash
191
- python -m webscout.Extra.tempmail.cli --help
192
- ```
193
-
194
- **Example: Get a temp email and watch for messages:**
195
-
196
- ```bash
197
- # This will generate an email and check for new messages every 15 seconds
198
- python -m webscout.Extra.tempmail.cli --wait 15
199
- ```
200
-
201
- **CLI Options:**
202
-
203
- * `--provider {mailtm,tempmailio}`: Specify the provider to use (default: mailtm).
204
- * `--wait SECONDS`: Wait time in seconds between checking for new messages (default: 10). Set to 0 to check once and exit.
205
- * `--output {simple,detailed}`: Control the level of detail in the output (default: simple). `detailed` usually shows message bodies.
206
-
207
- ## 📚 API Reference
208
-
209
- The module is built around abstract base classes for providers, ensuring a consistent interface.
210
-
211
- ### Base Abstract Classes
212
-
213
- * `TempMailProvider`: Defines the interface for synchronous temporary email providers.
214
- * `AsyncTempMailProvider`: Defines the interface for asynchronous temporary email providers.
215
-
216
- ### Provider Implementations
217
-
218
- #### Mail.TM
219
-
220
- * **`MailTM`**: Synchronous client for the Mail.TM service.
221
- * **`MailTMAsync`**: Asynchronous client for the Mail.TM service.
222
-
223
- #### TempMail.io
224
-
225
- * **`TempMailIO`**: Synchronous client for the TempMail.io service.
226
- * **`TempMailIOAsync`**: Asynchronous client for the TempMail.io service.
227
-
228
- ### Factory Functions
229
-
230
- * **`get_provider(provider_name: str, async_provider: bool = False) -> Union[TempMailProvider, AsyncTempMailProvider]`**:
231
- Retrieves an initialized provider instance based on its name (`'mailtm'` or `'tempmailio'`) and whether an async version is needed.
232
- * **`get_random_email(provider_name: Optional[str] = None) -> Tuple[str, TempMailProvider]`**:
233
- Generates a random email address using either the specified provider or a randomly selected one. Returns the email address and the synchronous provider instance.
234
- * **`get_disposable_email()`**: An alias for `get_random_email()`.
235
-
236
- ### Asynchronous Utilities (`webscout.Extra.tempmail.async_utils`)
237
-
238
- * **`AsyncTempMailHelper`**: A helper class simplifying common asynchronous operations like email creation and message waiting.
239
- * **`get_temp_email(alias: Optional[str] = None, domain: Optional[str] = None) -> Tuple[str, AsyncTempMailHelper]`**:
240
- Asynchronously creates a temporary email using the helper. Returns the email address and the helper instance.
241
- * **`wait_for_message(helper: AsyncTempMailHelper, timeout: int = 60, check_interval: int = 5) -> Optional[dict]`**:
242
- Asynchronously waits for a message to arrive for the email managed by the `helper`. Returns the message dictionary or `None` if timeout occurs.
243
-
244
- ## Advanced Usage Examples
245
-
246
- ### Automated Email Verification Workflow (Async)
247
-
248
- ```python
249
- import asyncio
250
- from webscout.Extra.tempmail import get_provider
251
- # Assume extract_link_from_message is defined elsewhere
252
- # from your_parsing_utils import extract_link_from_message
253
-
254
- async def verify_email_signup(service_url, username):
255
- """
256
- Attempts to sign up for a service using a temp email and
257
- retrieve the verification link.
258
- """
259
- provider = get_provider("mailtm", async_provider=True)
260
- await provider.initialize()
261
- print(f"[*] Initialized async provider for {service_url} signup")
262
-
263
- email_data = None
264
- verification_link = None
265
-
266
- try:
267
- email_data = await provider.create_email()
268
- email = email_data['address']
269
- print(f"[*] Generated temp email: {email} for {username}")
270
-
271
- # --- Placeholder for your signup logic ---
272
- print(f"[*] Attempting signup on {service_url} with {email}...")
273
- # success = await sign_up_to_service(service_url, username, email)
274
- success = True # Assume signup initiates email sending
275
- if not success:
276
- print("[!] Service signup failed.")
277
- return None
278
- # -----------------------------------------
279
-
280
- print("[*] Waiting for verification email...")
281
- # Wait up to 2 minutes (12 checks * 10 seconds interval)
282
- for attempt in range(12):
283
- print(f"[*] Checking for messages (Attempt {attempt + 1}/12)...")
284
- messages = await provider.get_messages()
285
-
286
- # Simple check: look for "verify" or "confirm" in subject
287
- verification_msg = next((
288
- m for m in messages
289
- if "verify" in m.get('subject', '').lower() or \
290
- "confirm" in m.get('subject', '').lower()
291
- ), None)
292
-
293
- if verification_msg:
294
- print("[+] Verification email found!")
295
- print(f" Subject: {verification_msg.get('subject')}")
296
- # --- Placeholder for link extraction ---
297
- # verification_link = extract_link_from_message(verification_msg.get('body', ''))
298
- verification_link = f"http://example.com/verify?token=xyz..." # Dummy link
299
- # -------------------------------------
300
- if verification_link:
301
- print(f"[+] Extracted verification link: {verification_link}")
302
- break # Exit loop once link is found
303
- else:
304
- print("[!] Found email, but failed to extract link.")
305
-
306
- await asyncio.sleep(10) # Wait before next check
307
-
308
- if not verification_link:
309
- print("[!] Timed out waiting for verification email or link.")
310
-
311
- except Exception as e:
312
- print(f"[!] An error occurred: {e}")
313
- finally:
314
- # Clean up regardless of success/failure
315
- if email_data:
316
- print("[*] Cleaning up temporary email...")
317
- try:
318
- # Adjust deletion based on provider needs (ID, token, etc.)
319
- await provider.delete_email(email_data['id'], email_data['token'])
320
- print("[*] Temporary email deleted.")
321
- except Exception as del_e:
322
- print(f"[!] Error during email deletion: {del_e}")
323
-
324
- await provider.close()
325
- print("[*] Async provider closed.")
326
-
327
- return verification_link
328
-
329
- # Example call (replace with actual service interaction)
330
- # asyncio.run(verify_email_signup("https://some-service.com/signup", "testuser123"))
331
- ```
332
-
333
- ### Testing Email Functionality (Sync)
334
-
335
- ```python
336
- from webscout.Extra.tempmail import get_random_email
337
- import time
338
- # Assume send_test_email is a function you have defined
339
- # from your_email_sending_module import send_test_email
340
-
341
- def test_email_sending_feature():
342
- """Tests if an email sent to a temp address is received."""
343
- print("[*] Starting email sending test...")
344
- email, provider = get_random_email()
345
- print(f"[*] Generated temp email for receiving: {email}")
346
-
347
- test_subject = "My Test Email Subject"
348
- test_content = "This is the body of the test email."
349
- test_email_received = False
350
-
351
- try:
352
- # --- Placeholder for your email sending logic ---
353
- print(f"[*] Sending test email to {email}...")
354
- # success = send_test_email(email, test_subject, test_content)
355
- success = True # Assume sending works
356
- if not success:
357
- print("[!] Failed to send test email.")
358
- return False
359
- # ---------------------------------------------
360
-
361
- print("[*] Waiting a few seconds for email delivery...")
362
- time.sleep(15) # Allow time for email to arrive
363
-
364
- print("[*] Checking inbox...")
365
- messages = provider.get_messages()
366
-
367
- if not messages:
368
- print("[!] No messages received in the temporary inbox.")
369
- else:
370
- print(f"[*] Received {len(messages)} message(s). Checking for test email...")
371
- for msg in messages:
372
- if msg.get('subject') == test_subject:
373
- print(f"[+] Test email received successfully!")
374
- print(f" From: {msg.get('from')}")
375
- # Optional: Verify content
376
- # if test_content in msg.get('body', ''):
377
- # print("[+] Email content verified.")
378
- test_email_received = True
379
- break # Found the email
380
- if not test_email_received:
381
- print(f"[!] Test email with subject '{test_subject}' not found.")
382
-
383
- except Exception as e:
384
- print(f"[!] An error occurred during the test: {e}")
385
- finally:
386
- # Clean up the temporary email account
387
- print("[*] Deleting temporary email account...")
388
- try:
389
- provider.delete_account() # Adjust if deletion needs specific info
390
- print("[*] Account deleted.")
391
- except Exception as del_e:
392
- print(f"[!] Error deleting account: {del_e}")
393
-
394
- print(f"[*] Email sending test result: {'Success' if test_email_received else 'Failure'}")
395
- return test_email_received
396
-
397
- # Run the test
398
- # test_result = test_email_sending_feature()
399
- ```
400
-
401
- ### Using Async Helper Utilities
402
-
403
- ```python
404
- import asyncio
405
- from webscout.Extra.tempmail.async_utils import get_temp_email, wait_for_message
406
-
407
- async def use_async_helpers():
408
- email = None
409
- helper = None
410
- print("[*] Using async helper utilities...")
411
- try:
412
- # 1. Create a new email using the helper
413
- email, helper = await get_temp_email()
414
- print(f"[*] Temporary email created via helper: {email}")
415
-
416
- # 2. Wait for a message to arrive (timeout after 60 seconds)
417
- print("[*] Waiting for a message (up to 60s)...")
418
- # Simulate sending an email here if needed for testing
419
- # await send_email_to(email, "Helper Test", "Body content")
420
-
421
- message = await wait_for_message(helper, timeout=60, check_interval=5)
422
-
423
- if message:
424
- print("[+] Message received!")
425
- print(f" From: {message.get('from', 'N/A')}")
426
- print(f" Subject: {message.get('subject', 'N/A')}")
427
- # print(f"Body: {message.get('body', 'N/A')[:100]}...") # Optional: print body snippet
428
- else:
429
- print("[!] No messages received within the 60-second timeout period.")
430
-
431
- except Exception as e:
432
- print(f"[!] An error occurred: {e}")
433
- finally:
434
- # 3. Clean up using the helper's delete method
435
- if helper:
436
- print("[*] Cleaning up email via helper...")
437
- await helper.delete()
438
- print("[*] Email deleted by helper.")
439
- else:
440
- print("[!] Helper instance not available for cleanup.")
441
-
442
- # Run the async function
443
- if __name__ == "__main__":
444
- asyncio.run(use_async_helpers())
445
- ```
446
-
447
- ## 🔌 Provider Integration
448
-
449
- Adding support for a new temporary email service is straightforward thanks to the abstract provider pattern used throughout Webscout:
450
-
451
- 1. **Create Provider Classes**: Implement two new classes:
452
- * One inheriting from `webscout.Extra.tempmail.base.TempMailProvider` for synchronous operations.
453
- * One inheriting from `webscout.Extra.tempmail.base.AsyncTempMailProvider` for asynchronous operations.
454
- Implement all the abstract methods defined in the base classes (e.g., `create_account`/`create_email`, `get_messages`, `delete_account`/`delete_email`).
455
- 2. **Register in Factory**: Update the `get_provider` function in `webscout/Extra/tempmail/base.py` to recognize a new `provider_name` string and return instances of your newly created classes.
456
- 3. **Expose (Optional)**: If desired, update `webscout/Extra/tempmail/__init__.py` to directly import and expose your new provider classes for users who might want to instantiate them directly.
457
- 4. **Add Tests**: Create unit and integration tests for your new provider to ensure it functions correctly.
458
- 5. **Update Documentation**: Add your new provider to this README, including any specific usage notes.
459
-
460
- ## 🛠️ Implementation Details
461
-
462
- * **Parser**: Uses the `Scout` HTML/XML parser from the core `webscout` library instead of external libraries like `BeautifulSoup` for consistency and potentially better performance within the Webscout ecosystem.
463
- * **Sync/Async Parity**: Aims to provide feature parity between the synchronous (`TempMailProvider`) and asynchronous (`AsyncTempMailProvider`) interfaces for all supported providers.
464
- * **Factories**: Relies on factory functions (`get_provider`, `get_random_email`) for easy and consistent instantiation of provider objects.
465
- * **Minimal Dependencies**: Avoids adding external logging or unnecessary dependencies to ensure smooth integration into projects using Webscout.
466
-
467
- ## 🤝 Contributing
468
-
469
- Contributions to enhance the TempMail module are highly welcome! Potential areas include:
470
-
471
- 1. **Adding New Providers**: Integrating support for additional temporary email services.
472
- 2. **Improving CLI**: Enhancing the command-line interface with more features or better output formatting.
473
- 3. **Robustness**: Improving error handling, retries, and provider-specific edge cases.
474
- 4. **Utility Functions**: Adding more helper functions for common temporary email automation tasks.
475
- 5. **Documentation**: Refining examples, API descriptions, and usage guides.
476
-
477
- Please refer to the main Webscout project's contributing guidelines if you plan to submit a pull request.
478
-
479
- <div align="center">
480
- <!-- Footer Links (Mirrored from main README) -->
481
- <div>
482
- <a href="https://t.me/PyscoutAI"><img alt="Telegram Group" src="https://img.shields.io/badge/Telegram%20Group-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
483
- <a href="https://t.me/ANONYMOUS_56788"><img alt="Developer Telegram" src="https://img.shields.io/badge/Developer%20Contact-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
484
- <a href="https://buymeacoffee.com/oevortex"><img alt="Buy Me A Coffee" src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black"></a>
485
- </div>
486
- <p>📧 TempMail - Part of the Webscout Toolkit</p>
487
- <a href="https://github.com/OEvortex/Webscout">Back to Main Webscout Project</a>
1
+ <div align="center">
2
+ <a href="https://github.com/pyscout/Webscout">
3
+ <img src="https://img.shields.io/badge/WebScout-TempMail%20Toolkit-blue?style=for-the-badge&logo=maildotru&logoColor=white" alt="WebScout TempMail Toolkit">
4
+ </a>
5
+
6
+ <h1>📧 TempMail</h1>
7
+
8
+ <p><strong>Powerful Temporary Email Generation & Management</strong></p>
9
+
10
+ <p>
11
+ Create disposable email addresses, manage messages, and automate email verification workflows with multiple providers and both synchronous and asynchronous APIs.
12
+ </p>
13
+
14
+ <!-- Badges -->
15
+ <p>
16
+ <a href="https://pypi.org/project/webscout/"><img src="https://img.shields.io/pypi/v/webscout.svg?style=flat-square&logo=pypi&label=PyPI" alt="PyPI Version"></a>
17
+ <a href="#"><img src="https://img.shields.io/badge/No%20API%20Key-Required-success?style=flat-square" alt="No API Key Required"></a>
18
+ <a href="#"><img src="https://img.shields.io/badge/Python-3.7%2B-blue?style=flat-square&logo=python" alt="Python Version"></a>
19
+ </p>
20
+ </div>
21
+
22
+ > [!NOTE]
23
+ > TempMail provides disposable email addresses for testing, verification, and privacy protection. It supports multiple providers and offers both synchronous and asynchronous interfaces.
24
+
25
+ ## ✨ Key Features
26
+
27
+ ### Email Management
28
+
29
+ * **Multiple Provider Support**
30
+ * Native integration with Mail.TM and TempMail.io services
31
+ * Extensible architecture for adding new providers
32
+ * Consistent interface across all providers
33
+
34
+ * **Privacy Protection**
35
+ * Generate disposable email addresses on demand
36
+ * Protect your primary inbox from spam
37
+ * Automatic cleanup after use
38
+
39
+ ### Developer Experience
40
+
41
+ * **Dual API Support**
42
+ * Synchronous interface for simple scripts
43
+ * Asynchronous interface for high-performance applications
44
+ * Complete feature parity between both interfaces
45
+
46
+ * **Automation Tools**
47
+ * Helper utilities for common workflows
48
+ * Email verification automation
49
+ * Message waiting and processing
50
+
51
+ * **Command Line Interface**
52
+ * Direct terminal access to all features
53
+ * Real-time message monitoring
54
+ * Simple and detailed output modes
55
+
56
+ ## 🚀 Installation
57
+
58
+ Install or update Webscout to get access to the TempMail module:
59
+
60
+ ```bash
61
+ pip install -U webscout
62
+ ```
63
+
64
+ ## 🖥️ Usage
65
+
66
+ ### Basic Synchronous Example
67
+
68
+ ```python
69
+ from webscout.Extra.tempmail import get_random_email
70
+
71
+ # 1. Create a new temporary email (provider chosen automatically)
72
+ email, provider = get_random_email()
73
+ print(f"[*] Your temporary email: {email}")
74
+ print(f"[*] Provider: {type(provider).__name__}")
75
+
76
+ try:
77
+ # 2. Check for incoming messages
78
+ print("[*] Waiting for messages...")
79
+ # Add a small delay or implement a loop if checking immediately
80
+ import time
81
+ time.sleep(10)
82
+
83
+ messages = provider.get_messages()
84
+ if not messages:
85
+ print("[*] No messages received yet.")
86
+ else:
87
+ print(f"[*] Received {len(messages)} message(s):")
88
+ for i, message in enumerate(messages):
89
+ print(f"\n--- Message {i+1} ---")
90
+ print(f" From: {message.get('from', 'N/A')}")
91
+ print(f" Subject: {message.get('subject', 'N/A')}")
92
+ # Optionally print body, be mindful of length
93
+ # print(f" Body: {message.get('body', 'N/A')[:100]}...")
94
+
95
+ finally:
96
+ # 3. Clean up: Delete the account/email when done
97
+ print("[*] Deleting temporary email account...")
98
+ provider.delete_account() # Adjust based on provider (delete_account or delete_email)
99
+ print("[*] Account deleted.")
100
+
101
+ ```
102
+
103
+ ### Choosing a Specific Provider
104
+
105
+ ```python
106
+ from webscout.Extra.tempmail import get_provider
107
+
108
+ # Use Mail.TM (default if unspecified in get_random_email)
109
+ print("[*] Using Mail.TM Provider")
110
+ mailtm_provider = get_provider("mailtm")
111
+ # MailTM typically uses create_account() which generates email+token
112
+ account_info = mailtm_provider.create_account()
113
+ print(f"[*] Mail.TM Email: {account_info['address']}")
114
+ # ... use mailtm_provider.get_messages(), etc. ...
115
+ mailtm_provider.delete_account(account_info['id'], account_info['token']) # Requires ID and Token for deletion
116
+ print("[*] Mail.TM account deleted.")
117
+
118
+
119
+ # Use TempMail.io
120
+ print("\n[*] Using TempMail.io Provider")
121
+ tempmailio_provider = get_provider("tempmailio")
122
+ # TempMail.io might have a different creation flow (check implementation)
123
+ # Assuming it also uses create_account() that returns an email address
124
+ email_info = tempmailio_provider.create_account() # Adapt if method/return differs
125
+ temp_email_io_addr = email_info # Adjust based on actual return value
126
+ print(f"[*] TempMail.io Email: {temp_email_io_addr}")
127
+ # ... use tempmailio_provider.get_messages(), etc. ...
128
+ tempmailio_provider.delete_account() # Adapt if deletion needs specific info
129
+ print("[*] TempMail.io account deleted.")
130
+ ```
131
+
132
+ ### Asynchronous API Example
133
+
134
+ ```python
135
+ import asyncio
136
+ from webscout.Extra.tempmail import get_provider
137
+
138
+ async def manage_temp_email_async():
139
+ # 1. Get an async provider instance (e.g., Mail.TM)
140
+ provider = get_provider("mailtm", async_provider=True)
141
+ await provider.initialize() # Important for async providers
142
+ print("[*] Async Provider Initialized (Mail.TM)")
143
+
144
+ try:
145
+ # 2. Create a new email (async method)
146
+ # Note: Method might be create_email or create_account depending on provider
147
+ email_data = await provider.create_email() # Adjust if method/return differs
148
+ email = email_data['address'] # Adjust based on actual return keys
149
+ token = email_data.get('token') # Get token if applicable
150
+ email_id = email_data.get('id') # Get ID if applicable
151
+ print(f"[*] Your temporary email: {email}")
152
+
153
+ # 3. Check for messages (async method)
154
+ print("[*] Waiting for messages (async)...")
155
+ await asyncio.sleep(15) # Wait a bit for potential incoming mail
156
+
157
+ messages = await provider.get_messages()
158
+ if not messages:
159
+ print("[*] No messages received yet.")
160
+ else:
161
+ print(f"[*] Received {len(messages)} message(s):")
162
+ for i, message in enumerate(messages):
163
+ print(f"\n--- Message {i+1} ---")
164
+ print(f" From: {message.get('from', 'N/A')}")
165
+ print(f" Subject: {message.get('subject', 'N/A')}")
166
+
167
+ finally:
168
+ # 4. Clean up (async methods)
169
+ print("[*] Deleting temporary email (async)...")
170
+ # Deletion method and required arguments depend on the provider
171
+ if token and email_id:
172
+ await provider.delete_email(email_id, token) # Example for MailTM-like
173
+ elif hasattr(provider, 'delete_email') and not token and not email_id:
174
+ await provider.delete_email(email) # Example if only email needed
175
+ else:
176
+ print("[!] Could not determine deletion method/parameters. Manual cleanup might be needed.")
177
+
178
+ await provider.close() # Close the underlying HTTP client
179
+ print("[*] Provider closed.")
180
+
181
+ # Run the async function
182
+ if __name__ == "__main__":
183
+ asyncio.run(manage_temp_email_async())
184
+ ```
185
+
186
+ ### Command Line Interface (CLI)
187
+
188
+ Access temporary email features directly from your terminal:
189
+
190
+ ```bash
191
+ python -m webscout.Extra.tempmail.cli --help
192
+ ```
193
+
194
+ **Example: Get a temp email and watch for messages:**
195
+
196
+ ```bash
197
+ # This will generate an email and check for new messages every 15 seconds
198
+ python -m webscout.Extra.tempmail.cli --wait 15
199
+ ```
200
+
201
+ **CLI Options:**
202
+
203
+ * `--provider {mailtm,tempmailio}`: Specify the provider to use (default: mailtm).
204
+ * `--wait SECONDS`: Wait time in seconds between checking for new messages (default: 10). Set to 0 to check once and exit.
205
+ * `--output {simple,detailed}`: Control the level of detail in the output (default: simple). `detailed` usually shows message bodies.
206
+
207
+ ## 📚 API Reference
208
+
209
+ The module is built around abstract base classes for providers, ensuring a consistent interface.
210
+
211
+ ### Base Abstract Classes
212
+
213
+ * `TempMailProvider`: Defines the interface for synchronous temporary email providers.
214
+ * `AsyncTempMailProvider`: Defines the interface for asynchronous temporary email providers.
215
+
216
+ ### Provider Implementations
217
+
218
+ #### Mail.TM
219
+
220
+ * **`MailTM`**: Synchronous client for the Mail.TM service.
221
+ * **`MailTMAsync`**: Asynchronous client for the Mail.TM service.
222
+
223
+ #### TempMail.io
224
+
225
+ * **`TempMailIO`**: Synchronous client for the TempMail.io service.
226
+ * **`TempMailIOAsync`**: Asynchronous client for the TempMail.io service.
227
+
228
+ ### Factory Functions
229
+
230
+ * **`get_provider(provider_name: str, async_provider: bool = False) -> Union[TempMailProvider, AsyncTempMailProvider]`**:
231
+ Retrieves an initialized provider instance based on its name (`'mailtm'` or `'tempmailio'`) and whether an async version is needed.
232
+ * **`get_random_email(provider_name: Optional[str] = None) -> Tuple[str, TempMailProvider]`**:
233
+ Generates a random email address using either the specified provider or a randomly selected one. Returns the email address and the synchronous provider instance.
234
+ * **`get_disposable_email()`**: An alias for `get_random_email()`.
235
+
236
+ ### Asynchronous Utilities (`webscout.Extra.tempmail.async_utils`)
237
+
238
+ * **`AsyncTempMailHelper`**: A helper class simplifying common asynchronous operations like email creation and message waiting.
239
+ * **`get_temp_email(alias: Optional[str] = None, domain: Optional[str] = None) -> Tuple[str, AsyncTempMailHelper]`**:
240
+ Asynchronously creates a temporary email using the helper. Returns the email address and the helper instance.
241
+ * **`wait_for_message(helper: AsyncTempMailHelper, timeout: int = 60, check_interval: int = 5) -> Optional[dict]`**:
242
+ Asynchronously waits for a message to arrive for the email managed by the `helper`. Returns the message dictionary or `None` if timeout occurs.
243
+
244
+ ## Advanced Usage Examples
245
+
246
+ ### Automated Email Verification Workflow (Async)
247
+
248
+ ```python
249
+ import asyncio
250
+ from webscout.Extra.tempmail import get_provider
251
+ # Assume extract_link_from_message is defined elsewhere
252
+ # from your_parsing_utils import extract_link_from_message
253
+
254
+ async def verify_email_signup(service_url, username):
255
+ """
256
+ Attempts to sign up for a service using a temp email and
257
+ retrieve the verification link.
258
+ """
259
+ provider = get_provider("mailtm", async_provider=True)
260
+ await provider.initialize()
261
+ print(f"[*] Initialized async provider for {service_url} signup")
262
+
263
+ email_data = None
264
+ verification_link = None
265
+
266
+ try:
267
+ email_data = await provider.create_email()
268
+ email = email_data['address']
269
+ print(f"[*] Generated temp email: {email} for {username}")
270
+
271
+ # --- Placeholder for your signup logic ---
272
+ print(f"[*] Attempting signup on {service_url} with {email}...")
273
+ # success = await sign_up_to_service(service_url, username, email)
274
+ success = True # Assume signup initiates email sending
275
+ if not success:
276
+ print("[!] Service signup failed.")
277
+ return None
278
+ # -----------------------------------------
279
+
280
+ print("[*] Waiting for verification email...")
281
+ # Wait up to 2 minutes (12 checks * 10 seconds interval)
282
+ for attempt in range(12):
283
+ print(f"[*] Checking for messages (Attempt {attempt + 1}/12)...")
284
+ messages = await provider.get_messages()
285
+
286
+ # Simple check: look for "verify" or "confirm" in subject
287
+ verification_msg = next((
288
+ m for m in messages
289
+ if "verify" in m.get('subject', '').lower() or \
290
+ "confirm" in m.get('subject', '').lower()
291
+ ), None)
292
+
293
+ if verification_msg:
294
+ print("[+] Verification email found!")
295
+ print(f" Subject: {verification_msg.get('subject')}")
296
+ # --- Placeholder for link extraction ---
297
+ # verification_link = extract_link_from_message(verification_msg.get('body', ''))
298
+ verification_link = f"http://example.com/verify?token=xyz..." # Dummy link
299
+ # -------------------------------------
300
+ if verification_link:
301
+ print(f"[+] Extracted verification link: {verification_link}")
302
+ break # Exit loop once link is found
303
+ else:
304
+ print("[!] Found email, but failed to extract link.")
305
+
306
+ await asyncio.sleep(10) # Wait before next check
307
+
308
+ if not verification_link:
309
+ print("[!] Timed out waiting for verification email or link.")
310
+
311
+ except Exception as e:
312
+ print(f"[!] An error occurred: {e}")
313
+ finally:
314
+ # Clean up regardless of success/failure
315
+ if email_data:
316
+ print("[*] Cleaning up temporary email...")
317
+ try:
318
+ # Adjust deletion based on provider needs (ID, token, etc.)
319
+ await provider.delete_email(email_data['id'], email_data['token'])
320
+ print("[*] Temporary email deleted.")
321
+ except Exception as del_e:
322
+ print(f"[!] Error during email deletion: {del_e}")
323
+
324
+ await provider.close()
325
+ print("[*] Async provider closed.")
326
+
327
+ return verification_link
328
+
329
+ # Example call (replace with actual service interaction)
330
+ # asyncio.run(verify_email_signup("https://some-service.com/signup", "testuser123"))
331
+ ```
332
+
333
+ ### Testing Email Functionality (Sync)
334
+
335
+ ```python
336
+ from webscout.Extra.tempmail import get_random_email
337
+ import time
338
+ # Assume send_test_email is a function you have defined
339
+ # from your_email_sending_module import send_test_email
340
+
341
+ def test_email_sending_feature():
342
+ """Tests if an email sent to a temp address is received."""
343
+ print("[*] Starting email sending test...")
344
+ email, provider = get_random_email()
345
+ print(f"[*] Generated temp email for receiving: {email}")
346
+
347
+ test_subject = "My Test Email Subject"
348
+ test_content = "This is the body of the test email."
349
+ test_email_received = False
350
+
351
+ try:
352
+ # --- Placeholder for your email sending logic ---
353
+ print(f"[*] Sending test email to {email}...")
354
+ # success = send_test_email(email, test_subject, test_content)
355
+ success = True # Assume sending works
356
+ if not success:
357
+ print("[!] Failed to send test email.")
358
+ return False
359
+ # ---------------------------------------------
360
+
361
+ print("[*] Waiting a few seconds for email delivery...")
362
+ time.sleep(15) # Allow time for email to arrive
363
+
364
+ print("[*] Checking inbox...")
365
+ messages = provider.get_messages()
366
+
367
+ if not messages:
368
+ print("[!] No messages received in the temporary inbox.")
369
+ else:
370
+ print(f"[*] Received {len(messages)} message(s). Checking for test email...")
371
+ for msg in messages:
372
+ if msg.get('subject') == test_subject:
373
+ print(f"[+] Test email received successfully!")
374
+ print(f" From: {msg.get('from')}")
375
+ # Optional: Verify content
376
+ # if test_content in msg.get('body', ''):
377
+ # print("[+] Email content verified.")
378
+ test_email_received = True
379
+ break # Found the email
380
+ if not test_email_received:
381
+ print(f"[!] Test email with subject '{test_subject}' not found.")
382
+
383
+ except Exception as e:
384
+ print(f"[!] An error occurred during the test: {e}")
385
+ finally:
386
+ # Clean up the temporary email account
387
+ print("[*] Deleting temporary email account...")
388
+ try:
389
+ provider.delete_account() # Adjust if deletion needs specific info
390
+ print("[*] Account deleted.")
391
+ except Exception as del_e:
392
+ print(f"[!] Error deleting account: {del_e}")
393
+
394
+ print(f"[*] Email sending test result: {'Success' if test_email_received else 'Failure'}")
395
+ return test_email_received
396
+
397
+ # Run the test
398
+ # test_result = test_email_sending_feature()
399
+ ```
400
+
401
+ ### Using Async Helper Utilities
402
+
403
+ ```python
404
+ import asyncio
405
+ from webscout.Extra.tempmail.async_utils import get_temp_email, wait_for_message
406
+
407
+ async def use_async_helpers():
408
+ email = None
409
+ helper = None
410
+ print("[*] Using async helper utilities...")
411
+ try:
412
+ # 1. Create a new email using the helper
413
+ email, helper = await get_temp_email()
414
+ print(f"[*] Temporary email created via helper: {email}")
415
+
416
+ # 2. Wait for a message to arrive (timeout after 60 seconds)
417
+ print("[*] Waiting for a message (up to 60s)...")
418
+ # Simulate sending an email here if needed for testing
419
+ # await send_email_to(email, "Helper Test", "Body content")
420
+
421
+ message = await wait_for_message(helper, timeout=60, check_interval=5)
422
+
423
+ if message:
424
+ print("[+] Message received!")
425
+ print(f" From: {message.get('from', 'N/A')}")
426
+ print(f" Subject: {message.get('subject', 'N/A')}")
427
+ # print(f"Body: {message.get('body', 'N/A')[:100]}...") # Optional: print body snippet
428
+ else:
429
+ print("[!] No messages received within the 60-second timeout period.")
430
+
431
+ except Exception as e:
432
+ print(f"[!] An error occurred: {e}")
433
+ finally:
434
+ # 3. Clean up using the helper's delete method
435
+ if helper:
436
+ print("[*] Cleaning up email via helper...")
437
+ await helper.delete()
438
+ print("[*] Email deleted by helper.")
439
+ else:
440
+ print("[!] Helper instance not available for cleanup.")
441
+
442
+ # Run the async function
443
+ if __name__ == "__main__":
444
+ asyncio.run(use_async_helpers())
445
+ ```
446
+
447
+ ## 🔌 Provider Integration
448
+
449
+ Adding support for a new temporary email service is straightforward thanks to the abstract provider pattern used throughout Webscout:
450
+
451
+ 1. **Create Provider Classes**: Implement two new classes:
452
+ * One inheriting from `webscout.Extra.tempmail.base.TempMailProvider` for synchronous operations.
453
+ * One inheriting from `webscout.Extra.tempmail.base.AsyncTempMailProvider` for asynchronous operations.
454
+ Implement all the abstract methods defined in the base classes (e.g., `create_account`/`create_email`, `get_messages`, `delete_account`/`delete_email`).
455
+ 2. **Register in Factory**: Update the `get_provider` function in `webscout/Extra/tempmail/base.py` to recognize a new `provider_name` string and return instances of your newly created classes.
456
+ 3. **Expose (Optional)**: If desired, update `webscout/Extra/tempmail/__init__.py` to directly import and expose your new provider classes for users who might want to instantiate them directly.
457
+ 4. **Add Tests**: Create unit and integration tests for your new provider to ensure it functions correctly.
458
+ 5. **Update Documentation**: Add your new provider to this README, including any specific usage notes.
459
+
460
+ ## 🛠️ Implementation Details
461
+
462
+ * **Parser**: Uses the `Scout` HTML/XML parser from the core `webscout` library instead of external libraries like `BeautifulSoup` for consistency and potentially better performance within the Webscout ecosystem.
463
+ * **Sync/Async Parity**: Aims to provide feature parity between the synchronous (`TempMailProvider`) and asynchronous (`AsyncTempMailProvider`) interfaces for all supported providers.
464
+ * **Factories**: Relies on factory functions (`get_provider`, `get_random_email`) for easy and consistent instantiation of provider objects.
465
+ * **Minimal Dependencies**: Avoids adding external logging or unnecessary dependencies to ensure smooth integration into projects using Webscout.
466
+
467
+ ## 🤝 Contributing
468
+
469
+ Contributions to enhance the TempMail module are highly welcome! Potential areas include:
470
+
471
+ 1. **Adding New Providers**: Integrating support for additional temporary email services.
472
+ 2. **Improving CLI**: Enhancing the command-line interface with more features or better output formatting.
473
+ 3. **Robustness**: Improving error handling, retries, and provider-specific edge cases.
474
+ 4. **Utility Functions**: Adding more helper functions for common temporary email automation tasks.
475
+ 5. **Documentation**: Refining examples, API descriptions, and usage guides.
476
+
477
+ Please refer to the main Webscout project's contributing guidelines if you plan to submit a pull request.
478
+
479
+ <div align="center">
480
+ <!-- Footer Links (Mirrored from main README) -->
481
+ <div>
482
+ <a href="https://t.me/PyscoutAI"><img alt="Telegram Group" src="https://img.shields.io/badge/Telegram%20Group-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
483
+ <a href="https://t.me/ANONYMOUS_56788"><img alt="Developer Telegram" src="https://img.shields.io/badge/Developer%20Contact-2CA5E0?style=for-the-badge&logo=telegram&logoColor=white"></a>
484
+ <a href="https://buymeacoffee.com/oevortex"><img alt="Buy Me A Coffee" src="https://img.shields.io/badge/Buy%20Me%20A%20Coffee-FFDD00?style=for-the-badge&logo=buymeacoffee&logoColor=black"></a>
485
+ </div>
486
+ <p>📧 TempMail - Part of the Webscout Toolkit</p>
487
+ <a href="https://github.com/pyscout/Webscout">Back to Main Webscout Project</a>
488
488
  </div>