nadeshiko-sdk-py 2.6.0__tar.gz

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 (296) hide show
  1. nadeshiko_sdk_py-2.6.0/.gitignore +20 -0
  2. nadeshiko_sdk_py-2.6.0/LICENSE +21 -0
  3. nadeshiko_sdk_py-2.6.0/PKG-INFO +261 -0
  4. nadeshiko_sdk_py-2.6.0/README.md +249 -0
  5. nadeshiko_sdk_py-2.6.0/pyproject.toml +22 -0
  6. nadeshiko_sdk_py-2.6.0/src/nadeshiko/__init__.py +17 -0
  7. nadeshiko_sdk_py-2.6.0/src/nadeshiko/_operations.py +45 -0
  8. nadeshiko_sdk_py-2.6.0/src/nadeshiko/_version.py +1 -0
  9. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/__init__.py +1 -0
  10. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/activity/__init__.py +1 -0
  11. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/activity/get_user_activity_heatmap.py +196 -0
  12. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/activity/get_user_activity_stats.py +200 -0
  13. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/activity/list_familiar_media.py +192 -0
  14. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/activity/list_user_activity.py +246 -0
  15. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/__init__.py +1 -0
  16. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/add_segment_to_collection.py +218 -0
  17. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/create_collection.py +198 -0
  18. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/delete_collection.py +197 -0
  19. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/get_collection.py +211 -0
  20. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/list_collections.py +233 -0
  21. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/remove_segment_from_collection.py +211 -0
  22. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/collections/search_collection_segments.py +252 -0
  23. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/__init__.py +1 -0
  24. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/get_episode.py +213 -0
  25. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/get_media.py +199 -0
  26. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/get_segment.py +199 -0
  27. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/get_segment_context.py +286 -0
  28. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/list_episodes.py +241 -0
  29. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/media/list_media.py +256 -0
  30. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/search/__init__.py +1 -0
  31. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/search/get_search_stats.py +238 -0
  32. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/search/search.py +296 -0
  33. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/search/search_media.py +206 -0
  34. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/search/search_words.py +210 -0
  35. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/stats/__init__.py +1 -0
  36. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/stats/get_stats_overview.py +172 -0
  37. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/__init__.py +1 -0
  38. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/add_excluded_media.py +206 -0
  39. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/add_favorite_media.py +218 -0
  40. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/create_user_api_key.py +258 -0
  41. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/get_me.py +168 -0
  42. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/list_excluded_media.py +160 -0
  43. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/list_favorite_media.py +160 -0
  44. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/remove_excluded_media.py +195 -0
  45. nadeshiko_sdk_py-2.6.0/src/nadeshiko/api/user/remove_favorite_media.py +195 -0
  46. nadeshiko_sdk_py-2.6.0/src/nadeshiko/client.py +272 -0
  47. nadeshiko_sdk_py-2.6.0/src/nadeshiko/errors.py +91 -0
  48. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/__init__.py +509 -0
  49. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/account_quota_state.py +129 -0
  50. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/account_quota_state_quota_source.py +18 -0
  51. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/activity_type.py +16 -0
  52. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/add_excluded_media_body.py +61 -0
  53. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/add_favorite_media_body.py +61 -0
  54. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/add_segment_to_collection_request.py +61 -0
  55. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/admin_report_group.py +192 -0
  56. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/admin_report_group_item.py +125 -0
  57. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/admin_report_list_response.py +85 -0
  58. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/admin_user_with_providers.py +145 -0
  59. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/admin_user_with_providers_role.py +18 -0
  60. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/affected_count_response.py +62 -0
  61. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/agent_activity_response.py +75 -0
  62. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/agent_activity_response_entries_item.py +164 -0
  63. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/agent_activity_response_entries_item_current.py +50 -0
  64. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/agent_activity_response_entries_item_snapshot.py +47 -0
  65. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/announcement.py +84 -0
  66. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/announcement_type.py +15 -0
  67. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/api_key_scope.py +39 -0
  68. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/batch_update_reports_request.py +81 -0
  69. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/bulk_delete_reports_request.py +75 -0
  70. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/bulk_delete_reports_request_filters.py +133 -0
  71. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/bulk_update_reports_request.py +96 -0
  72. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/bulk_update_reports_request_filters.py +133 -0
  73. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/category.py +16 -0
  74. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/category_count.py +82 -0
  75. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection.py +131 -0
  76. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection_create_request.py +81 -0
  77. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection_list_response.py +86 -0
  78. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection_type.py +14 -0
  79. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection_update_request.py +78 -0
  80. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/collection_visibility.py +14 -0
  81. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/content_rating.py +16 -0
  82. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/covered_word.py +78 -0
  83. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/covered_words_response.py +96 -0
  84. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/covered_words_response_tier_stats.py +78 -0
  85. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/covered_words_update_request.py +72 -0
  86. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/covered_words_update_response.py +86 -0
  87. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/create_feedback_request.py +152 -0
  88. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/create_report_request.py +115 -0
  89. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/create_report_request_reason.py +43 -0
  90. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/create_user_api_key_body.py +80 -0
  91. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/create_user_api_key_response_201.py +106 -0
  92. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/cursor_pagination.py +77 -0
  93. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/episode.py +202 -0
  94. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/episode_create_request.py +146 -0
  95. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/episode_list_response.py +85 -0
  96. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/episode_update_request.py +135 -0
  97. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_400.py +131 -0
  98. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_400_code.py +15 -0
  99. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_400_errors.py +47 -0
  100. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_400_status.py +13 -0
  101. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_401.py +131 -0
  102. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_401_code.py +17 -0
  103. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_401_errors.py +47 -0
  104. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_401_status.py +13 -0
  105. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_403.py +131 -0
  106. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_403_code.py +14 -0
  107. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_403_errors.py +47 -0
  108. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_403_status.py +13 -0
  109. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_404.py +131 -0
  110. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_404_code.py +13 -0
  111. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_404_errors.py +47 -0
  112. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_404_status.py +13 -0
  113. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_409.py +131 -0
  114. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_409_code.py +14 -0
  115. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_409_errors.py +47 -0
  116. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_409_status.py +13 -0
  117. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_429.py +131 -0
  118. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_429_code.py +14 -0
  119. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_429_errors.py +47 -0
  120. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_429_status.py +13 -0
  121. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_500.py +131 -0
  122. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_500_code.py +13 -0
  123. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_500_errors.py +47 -0
  124. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_500_status.py +13 -0
  125. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_503.py +131 -0
  126. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_503_code.py +13 -0
  127. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_503_errors.py +47 -0
  128. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/error_503_status.py +13 -0
  129. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/external_id.py +148 -0
  130. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/feedback_form_token.py +61 -0
  131. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/feedback_receipt.py +64 -0
  132. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/get_user_activity_heatmap_response_200.py +74 -0
  133. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/get_user_activity_heatmap_response_200_activity_by_day.py +62 -0
  134. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/heatmap_day_counts.py +89 -0
  135. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/include_expansion.py +13 -0
  136. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_excluded_media_response_200.py +75 -0
  137. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_familiar_media_response_200.py +81 -0
  138. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_familiar_media_response_200_familiar_media_item.py +99 -0
  139. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_favorite_media_response_200.py +75 -0
  140. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_media_category.py +16 -0
  141. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/list_user_activity_response_200.py +85 -0
  142. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media.py +280 -0
  143. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_airing_format.py +19 -0
  144. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_airing_status.py +16 -0
  145. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_autocomplete_response.py +75 -0
  146. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_create_request.py +250 -0
  147. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_create_request_airing_format.py +23 -0
  148. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_create_request_airing_status.py +18 -0
  149. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_create_request_season_name.py +19 -0
  150. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_create_request_storage.py +16 -0
  151. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_filter_item.py +76 -0
  152. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_global_stats.py +78 -0
  153. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_list_response.py +95 -0
  154. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_search_stats.py +94 -0
  155. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_search_stats_episode_hits_item.py +92 -0
  156. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_season_name.py +17 -0
  157. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_summary.py +112 -0
  158. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_update_request.py +328 -0
  159. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_update_request_airing_format.py +23 -0
  160. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_update_request_airing_status.py +18 -0
  161. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_update_request_season_name.py +19 -0
  162. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/media_update_request_storage.py +16 -0
  163. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/moderate_episode_segments_request.py +118 -0
  164. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/moderate_episode_segments_request_action.py +18 -0
  165. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/patreon_connection.py +122 -0
  166. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report.py +245 -0
  167. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_data_type_0.py +47 -0
  168. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_reason.py +61 -0
  169. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_source.py +14 -0
  170. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_status.py +16 -0
  171. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_episode.py +82 -0
  172. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_episode_type.py +15 -0
  173. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_media.py +71 -0
  174. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_media_type.py +15 -0
  175. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_segment.py +98 -0
  176. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_segment_input.py +92 -0
  177. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_segment_input_type.py +15 -0
  178. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_segment_type.py +15 -0
  179. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/report_target_type.py +15 -0
  180. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item.py +216 -0
  181. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item_kind.py +14 -0
  182. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item_status.py +20 -0
  183. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item_write.py +213 -0
  184. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item_write_kind.py +16 -0
  185. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/roadmap_item_write_status.py +18 -0
  186. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters.py +237 -0
  187. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_languages_type_0_item.py +16 -0
  188. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_languages_type_1.py +78 -0
  189. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_languages_type_1_exclude_item.py +20 -0
  190. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_media.py +110 -0
  191. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_segment_duration_ms.py +71 -0
  192. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_filters_segment_length_chars.py +71 -0
  193. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_media_filters.py +75 -0
  194. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_media_request.py +94 -0
  195. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_multiple_query.py +73 -0
  196. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_multiple_request.py +109 -0
  197. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_multiple_response.py +95 -0
  198. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_multiple_response_includes.py +78 -0
  199. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_multiple_response_includes_media.py +60 -0
  200. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_pagination.py +103 -0
  201. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_pagination_estimated_total_hits_relation.py +20 -0
  202. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_query.py +72 -0
  203. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_request.py +176 -0
  204. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_response.py +105 -0
  205. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_response_includes.py +76 -0
  206. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_response_includes_media.py +60 -0
  207. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_sort.py +87 -0
  208. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_sort_mode.py +18 -0
  209. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_stats_request.py +115 -0
  210. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_stats_response.py +113 -0
  211. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_stats_response_includes.py +76 -0
  212. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/search_stats_response_includes_media.py +60 -0
  213. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment.py +203 -0
  214. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_batch_create_request.py +75 -0
  215. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_context_response.py +95 -0
  216. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_context_response_includes.py +78 -0
  217. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_context_response_includes_media.py +60 -0
  218. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request.py +227 -0
  219. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request_rating_analysis_type_0.py +47 -0
  220. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request_storage.py +16 -0
  221. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request_text_en.py +71 -0
  222. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request_text_es.py +71 -0
  223. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_create_request_text_ja.py +61 -0
  224. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_internal.py +302 -0
  225. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_internal_rating_analysis_type_0.py +47 -0
  226. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_internal_storage.py +16 -0
  227. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_list_response.py +85 -0
  228. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_revision.py +139 -0
  229. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_revision_actor.py +16 -0
  230. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_revision_snapshot.py +50 -0
  231. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_status.py +15 -0
  232. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_text_en.py +84 -0
  233. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_text_es.py +84 -0
  234. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_text_ja.py +117 -0
  235. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request.py +260 -0
  236. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request_rating_analysis_type_0.py +47 -0
  237. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request_storage.py +16 -0
  238. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request_text_en.py +70 -0
  239. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request_text_es.py +70 -0
  240. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_update_request_text_ja.py +61 -0
  241. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/segment_urls.py +78 -0
  242. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/shirabe_connection.py +201 -0
  243. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/shirabe_connection_dictionary_names.py +54 -0
  244. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/stats_overview.py +152 -0
  245. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/stats_overview_translations.py +93 -0
  246. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/tier.py +129 -0
  247. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/token.py +220 -0
  248. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/token_f_item.py +72 -0
  249. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/token_inflection.py +72 -0
  250. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/token_kind.py +19 -0
  251. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/token_parts_item.py +77 -0
  252. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/unsubscribe_receipt.py +64 -0
  253. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/update_account_quota_request.py +96 -0
  254. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/update_collection_segment_request.py +61 -0
  255. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/update_report_request.py +78 -0
  256. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_activity.py +150 -0
  257. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_activity_request.py +124 -0
  258. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_activity_request_activity_type.py +18 -0
  259. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_activity_stats.py +116 -0
  260. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_activity_stats_top_media_item.py +77 -0
  261. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_export_collection.py +138 -0
  262. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_export_response.py +173 -0
  263. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_export_response_media_affinity_item.py +93 -0
  264. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_export_response_profile.py +86 -0
  265. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_export_response_truncated.py +97 -0
  266. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_me.py +77 -0
  267. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_me_quota.py +150 -0
  268. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_me_quota_burst.py +73 -0
  269. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_me_quota_tier_type_0.py +72 -0
  270. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_me_user.py +78 -0
  271. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences.py +441 -0
  272. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_anki_profiles_item.py +185 -0
  273. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_anki_profiles_item_fields_item.py +69 -0
  274. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_content_rating_preferences.py +73 -0
  275. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_content_rating_preferences_nsfw.py +21 -0
  276. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_default_search_category.py +21 -0
  277. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_familiar_media.py +69 -0
  278. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_favorite_media_item.py +70 -0
  279. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_hidden_media_item.py +61 -0
  280. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_media_card_default.py +16 -0
  281. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_media_name_language.py +17 -0
  282. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_product_emails.py +102 -0
  283. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_search_history.py +61 -0
  284. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_translation_languages_item.py +18 -0
  285. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_translation_visibility_preferences.py +93 -0
  286. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_translation_visibility_preferences_en.py +21 -0
  287. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_translation_visibility_preferences_es.py +21 -0
  288. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_word_popup.py +77 -0
  289. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/user_preferences_word_popup_definition_size.py +19 -0
  290. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/word_coverage_tier.py +86 -0
  291. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/word_match.py +110 -0
  292. nadeshiko_sdk_py-2.6.0/src/nadeshiko/models/word_match_media.py +71 -0
  293. nadeshiko_sdk_py-2.6.0/src/nadeshiko/py.typed +0 -0
  294. nadeshiko_sdk_py-2.6.0/src/nadeshiko/sdk.py +658 -0
  295. nadeshiko_sdk_py-2.6.0/src/nadeshiko/sdk.pyi +397 -0
  296. nadeshiko_sdk_py-2.6.0/src/nadeshiko/types.py +54 -0
@@ -0,0 +1,20 @@
1
+ # Python
2
+ __pycache__/
3
+ *.py[cod]
4
+ *.egg-info/
5
+ dist/
6
+ build/
7
+
8
+ # Environment
9
+ .env
10
+ .venv/
11
+ venv/
12
+
13
+ # IDEs
14
+ .idea/
15
+ .vscode/
16
+ *.swp
17
+
18
+ # Cache
19
+ .ruff_cache/
20
+ .pytest_cache/
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) Nadeshiko
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,261 @@
1
+ Metadata-Version: 2.5
2
+ Name: nadeshiko-sdk-py
3
+ Version: 2.6.0
4
+ Summary: Python SDK for Nadeshiko API (public endpoints only)
5
+ License-Expression: MIT
6
+ License-File: LICENSE
7
+ Requires-Python: >=3.11
8
+ Requires-Dist: attrs>=23.0
9
+ Requires-Dist: httpx>=0.27.0
10
+ Requires-Dist: python-dateutil>=2.8.0
11
+ Description-Content-Type: text/markdown
12
+
13
+ # Nadeshiko SDK
14
+
15
+ Python SDK for the [Nadeshiko API](https://nadeshiko.co). Full API reference at [nadeshiko.co/docs/api](https://nadeshiko.co/docs/api/index.html).
16
+
17
+ ## Install
18
+
19
+ ```bash
20
+ pip install nadeshiko-sdk-py
21
+ ```
22
+
23
+ > **Moved:** this SDK used to be published as `nadeshiko-sdk` (last version 2.6.0). New releases are
24
+ > published only as `nadeshiko-sdk-py`. The import name is unchanged (`import nadeshiko`), so switch
25
+ > the package name in your requirements and uninstall the old one (`pip uninstall nadeshiko-sdk`).
26
+
27
+ ## Quick start
28
+
29
+ ```python
30
+ from nadeshiko import Nadeshiko
31
+ from nadeshiko.models import SearchQuery
32
+
33
+ client = Nadeshiko(
34
+ api_key=os.environ["NADESHIKO_API_KEY"],
35
+ )
36
+
37
+ data = client.search(query=SearchQuery(search="彼女"))
38
+ print(data.segments)
39
+ # [
40
+ # Segment(
41
+ # segment_public_id="xK9mP2nQwR4t",
42
+ # media_public_id="steins-gate",
43
+ # episode=1,
44
+ # start_time_ms=62340,
45
+ # end_time_ms=65180,
46
+ # text_ja=SegmentTextJa(content="彼女に会いたい", ...),
47
+ # text_en=SegmentTextEn(content="I want to see her", ...),
48
+ # urls=SegmentUrls(
49
+ # image_url="https://...",
50
+ # audio_url="https://...",
51
+ # video_url="https://...",
52
+ # ),
53
+ # ),
54
+ # # ...
55
+ # ]
56
+ ```
57
+
58
+ Methods return data directly and accept model objects — pass `SearchQuery`, `SearchFilters`, and other model instances directly.
59
+
60
+ ## Authentication
61
+
62
+ Pass your API key to `Nadeshiko`. It is sent as `Authorization: Bearer <api_key>` on every request.
63
+
64
+ ```python
65
+ client = Nadeshiko(
66
+ api_key=os.environ["NADESHIKO_API_KEY"],
67
+ base_url="PRODUCTION", # "LOCAL" | "DEVELOPMENT" | "STAGING" | "PRODUCTION" | custom URL
68
+ headers={"User-Agent": "MyApp/1.0"},
69
+ )
70
+ ```
71
+
72
+ ## Model objects
73
+
74
+ All methods accept model objects — body fields are passed as `SearchQuery`, `SearchFilters`, and other model instances:
75
+
76
+ ```python
77
+ from nadeshiko.models import SearchQuery, SearchFilters, ContentRating
78
+
79
+ # POST endpoints — body models
80
+ result = client.search(
81
+ query=SearchQuery(search="猫"),
82
+ filters=SearchFilters(content_rating=[ContentRating.SAFE]),
83
+ )
84
+
85
+ # GET with query params — as keyword arguments
86
+ media_list = client.list_media(query="naruto", category="ANIME")
87
+
88
+ # GET with path params — as keyword arguments or positional
89
+ collection = client.get_collection("collection-public-id")
90
+ episode = client.get_episode(media_public_id="abc", episode_number=5)
91
+ ```
92
+
93
+ Single-path-param endpoints also accept the ID as a plain string:
94
+
95
+ ```python
96
+ media = client.get_media("some-public-id")
97
+ segment = client.get_segment("some-uuid")
98
+ context = client.get_segment_context("some-uuid")
99
+ ```
100
+
101
+ ## Available endpoints
102
+
103
+ ### Search
104
+ | Method | Description |
105
+ |---|---|
106
+ | `search(params?)` | Search segments by query, with filters and sorting |
107
+ | `get_search_stats(params?)` | Category counts and media list for filter UI |
108
+ | `search_words(params)` | Look up multiple words and get match counts per media |
109
+ | `search_media(params)` | Find media by name (autocomplete) |
110
+
111
+ ### Stats
112
+ | Method | Description |
113
+ |---|---|
114
+ | `get_stats_overview()` | Corpus-wide stats: segment count, media count, coverage tiers |
115
+
116
+ ### Media
117
+ | Method | Description |
118
+ |---|---|
119
+ | `list_media(params?)` | Browse the media catalog |
120
+ | `get_media(id)` | Get a single media entry by public ID |
121
+ | `list_episodes(params)` | List episodes for a media entry |
122
+ | `get_episode(params)` | Get a single episode |
123
+ | `get_segment(id)` | Get a single segment by UUID |
124
+ | `get_segment_context(id)` | Get segments surrounding a given segment |
125
+
126
+ ### User
127
+ | Method | Description |
128
+ |---|---|
129
+ | `get_me()` | Current user profile and API quota |
130
+ | `list_user_activity(params?)` | Activity history (searches, plays, exports) |
131
+ | `get_user_activity_heatmap(params?)` | Daily activity counts for a heatmap |
132
+ | `get_user_activity_stats(params?)` | Aggregate stats over a date range |
133
+ | `list_excluded_media()` | Media hidden from search results |
134
+ | `add_excluded_media(params)` | Hide a media entry from search results |
135
+ | `remove_excluded_media(id)` | Un-hide a media entry |
136
+
137
+ ### Collections
138
+ | Method | Description |
139
+ |---|---|
140
+ | `list_collections(params?)` | List your saved collections |
141
+ | `create_collection(params)` | Create a new collection |
142
+ | `get_collection(id)` | Get a collection and its segments |
143
+ | `delete_collection(id)` | Delete a collection |
144
+ | `add_segment_to_collection(params)` | Add a segment to a collection |
145
+ | `search_collection_segments(params)` | Search within a collection |
146
+ | `remove_segment_from_collection(params)` | Remove a segment from a collection |
147
+
148
+ ## Error handling
149
+
150
+ Errors throw a `NadeshikoError`. A proper `Exception` subclass with all RFC 7807 Problem Details fields.
151
+
152
+ ```python
153
+ from nadeshiko import NadeshikoError
154
+ from nadeshiko.models import SearchQuery
155
+
156
+ try:
157
+ data = client.search(query=SearchQuery(search="食べる"))
158
+ print(data.segments)
159
+ except NadeshikoError as err:
160
+ match err.code:
161
+ case "VALIDATION_FAILED":
162
+ print("Validation failed:", err.detail)
163
+ for field, msg in (err.errors or {}).items():
164
+ print(f" {field}: {msg}")
165
+ case "AUTH_CREDENTIALS_REQUIRED" | "AUTH_CREDENTIALS_INVALID":
166
+ print("Authentication failed:", err.detail)
167
+ case "RATE_LIMIT_EXCEEDED":
168
+ print("Rate limited - slow down")
169
+ case "QUOTA_EXCEEDED":
170
+ print("Monthly quota exhausted")
171
+ case "INTERNAL_SERVER_EXCEPTION":
172
+ print("Server error, trace ID:", err.trace_id)
173
+ ```
174
+
175
+ **`NadeshikoError` fields:**
176
+
177
+ | Field | Type | Description |
178
+ |---|---|---|
179
+ | `code` | `str` | Machine-readable error code |
180
+ | `title` | `str` | Short summary |
181
+ | `detail` | `str` | Human-readable explanation |
182
+ | `status` | `int` | HTTP status code |
183
+ | `trace_id` | `str \| None` | Trace ID - include when reporting issues |
184
+ | `errors` | `dict[str, object] \| None` | Per-field messages (`VALIDATION_FAILED` only) |
185
+
186
+ ### Opt out of throwing per-call
187
+
188
+ Pass `throw_on_error=False` to get a response object instead of throwing:
189
+
190
+ ```python
191
+ from nadeshiko.models import SearchQuery
192
+
193
+ result = client.search(
194
+ throw_on_error=False,
195
+ query=SearchQuery(search="猫"),
196
+ )
197
+
198
+ if result.error is not None:
199
+ print(result.error)
200
+ else:
201
+ print(result.data.segments)
202
+ ```
203
+
204
+ ## Retry and timeout
205
+
206
+ The client retries automatically on network errors and `408 / 429 / 500 / 502 / 503 / 504` responses. `429` responses with a `Retry-After` header are respected.
207
+
208
+ ```python
209
+ from nadeshiko import Nadeshiko, RetryOptions
210
+
211
+ client = Nadeshiko(
212
+ api_key=os.environ["NADESHIKO_API_KEY"],
213
+ retry_options=RetryOptions(
214
+ max_retries=3, # default: 2
215
+ initial_delay=1, # default: 0.5 - doubles with each attempt
216
+ max_delay=30, # default: 30
217
+ timeout=10, # per-attempt timeout in seconds (default: none)
218
+ ),
219
+ )
220
+ ```
221
+
222
+ ## Pagination
223
+
224
+ Paginated endpoints have an `iter_*` method that returns an iterator over individual items:
225
+
226
+ ```python
227
+ from nadeshiko.models import SearchQuery
228
+
229
+ for segment in client.iter_search(
230
+ query=SearchQuery(search="猫"),
231
+ ):
232
+ print(segment.text_ja.content)
233
+
234
+ for media in client.iter_list_media():
235
+ print(media.name_en)
236
+ ```
237
+
238
+ For manual page-by-page control, use the `cursor` field:
239
+
240
+ ```python
241
+ from nadeshiko.models import SearchQuery
242
+
243
+ cursor: str | None = None
244
+
245
+ while True:
246
+ data = client.search(
247
+ query=SearchQuery(search="犬"),
248
+ take=10,
249
+ cursor=cursor,
250
+ )
251
+
252
+ for segment in data.segments:
253
+ print(segment.text_ja.content)
254
+
255
+ if not data.pagination.has_more or data.pagination.cursor is None:
256
+ break
257
+
258
+ cursor = data.pagination.cursor
259
+ ```
260
+
261
+ See [`examples/examples.py`](examples/examples.py) for more usage patterns.
@@ -0,0 +1,249 @@
1
+ # Nadeshiko SDK
2
+
3
+ Python SDK for the [Nadeshiko API](https://nadeshiko.co). Full API reference at [nadeshiko.co/docs/api](https://nadeshiko.co/docs/api/index.html).
4
+
5
+ ## Install
6
+
7
+ ```bash
8
+ pip install nadeshiko-sdk-py
9
+ ```
10
+
11
+ > **Moved:** this SDK used to be published as `nadeshiko-sdk` (last version 2.6.0). New releases are
12
+ > published only as `nadeshiko-sdk-py`. The import name is unchanged (`import nadeshiko`), so switch
13
+ > the package name in your requirements and uninstall the old one (`pip uninstall nadeshiko-sdk`).
14
+
15
+ ## Quick start
16
+
17
+ ```python
18
+ from nadeshiko import Nadeshiko
19
+ from nadeshiko.models import SearchQuery
20
+
21
+ client = Nadeshiko(
22
+ api_key=os.environ["NADESHIKO_API_KEY"],
23
+ )
24
+
25
+ data = client.search(query=SearchQuery(search="彼女"))
26
+ print(data.segments)
27
+ # [
28
+ # Segment(
29
+ # segment_public_id="xK9mP2nQwR4t",
30
+ # media_public_id="steins-gate",
31
+ # episode=1,
32
+ # start_time_ms=62340,
33
+ # end_time_ms=65180,
34
+ # text_ja=SegmentTextJa(content="彼女に会いたい", ...),
35
+ # text_en=SegmentTextEn(content="I want to see her", ...),
36
+ # urls=SegmentUrls(
37
+ # image_url="https://...",
38
+ # audio_url="https://...",
39
+ # video_url="https://...",
40
+ # ),
41
+ # ),
42
+ # # ...
43
+ # ]
44
+ ```
45
+
46
+ Methods return data directly and accept model objects — pass `SearchQuery`, `SearchFilters`, and other model instances directly.
47
+
48
+ ## Authentication
49
+
50
+ Pass your API key to `Nadeshiko`. It is sent as `Authorization: Bearer <api_key>` on every request.
51
+
52
+ ```python
53
+ client = Nadeshiko(
54
+ api_key=os.environ["NADESHIKO_API_KEY"],
55
+ base_url="PRODUCTION", # "LOCAL" | "DEVELOPMENT" | "STAGING" | "PRODUCTION" | custom URL
56
+ headers={"User-Agent": "MyApp/1.0"},
57
+ )
58
+ ```
59
+
60
+ ## Model objects
61
+
62
+ All methods accept model objects — body fields are passed as `SearchQuery`, `SearchFilters`, and other model instances:
63
+
64
+ ```python
65
+ from nadeshiko.models import SearchQuery, SearchFilters, ContentRating
66
+
67
+ # POST endpoints — body models
68
+ result = client.search(
69
+ query=SearchQuery(search="猫"),
70
+ filters=SearchFilters(content_rating=[ContentRating.SAFE]),
71
+ )
72
+
73
+ # GET with query params — as keyword arguments
74
+ media_list = client.list_media(query="naruto", category="ANIME")
75
+
76
+ # GET with path params — as keyword arguments or positional
77
+ collection = client.get_collection("collection-public-id")
78
+ episode = client.get_episode(media_public_id="abc", episode_number=5)
79
+ ```
80
+
81
+ Single-path-param endpoints also accept the ID as a plain string:
82
+
83
+ ```python
84
+ media = client.get_media("some-public-id")
85
+ segment = client.get_segment("some-uuid")
86
+ context = client.get_segment_context("some-uuid")
87
+ ```
88
+
89
+ ## Available endpoints
90
+
91
+ ### Search
92
+ | Method | Description |
93
+ |---|---|
94
+ | `search(params?)` | Search segments by query, with filters and sorting |
95
+ | `get_search_stats(params?)` | Category counts and media list for filter UI |
96
+ | `search_words(params)` | Look up multiple words and get match counts per media |
97
+ | `search_media(params)` | Find media by name (autocomplete) |
98
+
99
+ ### Stats
100
+ | Method | Description |
101
+ |---|---|
102
+ | `get_stats_overview()` | Corpus-wide stats: segment count, media count, coverage tiers |
103
+
104
+ ### Media
105
+ | Method | Description |
106
+ |---|---|
107
+ | `list_media(params?)` | Browse the media catalog |
108
+ | `get_media(id)` | Get a single media entry by public ID |
109
+ | `list_episodes(params)` | List episodes for a media entry |
110
+ | `get_episode(params)` | Get a single episode |
111
+ | `get_segment(id)` | Get a single segment by UUID |
112
+ | `get_segment_context(id)` | Get segments surrounding a given segment |
113
+
114
+ ### User
115
+ | Method | Description |
116
+ |---|---|
117
+ | `get_me()` | Current user profile and API quota |
118
+ | `list_user_activity(params?)` | Activity history (searches, plays, exports) |
119
+ | `get_user_activity_heatmap(params?)` | Daily activity counts for a heatmap |
120
+ | `get_user_activity_stats(params?)` | Aggregate stats over a date range |
121
+ | `list_excluded_media()` | Media hidden from search results |
122
+ | `add_excluded_media(params)` | Hide a media entry from search results |
123
+ | `remove_excluded_media(id)` | Un-hide a media entry |
124
+
125
+ ### Collections
126
+ | Method | Description |
127
+ |---|---|
128
+ | `list_collections(params?)` | List your saved collections |
129
+ | `create_collection(params)` | Create a new collection |
130
+ | `get_collection(id)` | Get a collection and its segments |
131
+ | `delete_collection(id)` | Delete a collection |
132
+ | `add_segment_to_collection(params)` | Add a segment to a collection |
133
+ | `search_collection_segments(params)` | Search within a collection |
134
+ | `remove_segment_from_collection(params)` | Remove a segment from a collection |
135
+
136
+ ## Error handling
137
+
138
+ Errors throw a `NadeshikoError`. A proper `Exception` subclass with all RFC 7807 Problem Details fields.
139
+
140
+ ```python
141
+ from nadeshiko import NadeshikoError
142
+ from nadeshiko.models import SearchQuery
143
+
144
+ try:
145
+ data = client.search(query=SearchQuery(search="食べる"))
146
+ print(data.segments)
147
+ except NadeshikoError as err:
148
+ match err.code:
149
+ case "VALIDATION_FAILED":
150
+ print("Validation failed:", err.detail)
151
+ for field, msg in (err.errors or {}).items():
152
+ print(f" {field}: {msg}")
153
+ case "AUTH_CREDENTIALS_REQUIRED" | "AUTH_CREDENTIALS_INVALID":
154
+ print("Authentication failed:", err.detail)
155
+ case "RATE_LIMIT_EXCEEDED":
156
+ print("Rate limited - slow down")
157
+ case "QUOTA_EXCEEDED":
158
+ print("Monthly quota exhausted")
159
+ case "INTERNAL_SERVER_EXCEPTION":
160
+ print("Server error, trace ID:", err.trace_id)
161
+ ```
162
+
163
+ **`NadeshikoError` fields:**
164
+
165
+ | Field | Type | Description |
166
+ |---|---|---|
167
+ | `code` | `str` | Machine-readable error code |
168
+ | `title` | `str` | Short summary |
169
+ | `detail` | `str` | Human-readable explanation |
170
+ | `status` | `int` | HTTP status code |
171
+ | `trace_id` | `str \| None` | Trace ID - include when reporting issues |
172
+ | `errors` | `dict[str, object] \| None` | Per-field messages (`VALIDATION_FAILED` only) |
173
+
174
+ ### Opt out of throwing per-call
175
+
176
+ Pass `throw_on_error=False` to get a response object instead of throwing:
177
+
178
+ ```python
179
+ from nadeshiko.models import SearchQuery
180
+
181
+ result = client.search(
182
+ throw_on_error=False,
183
+ query=SearchQuery(search="猫"),
184
+ )
185
+
186
+ if result.error is not None:
187
+ print(result.error)
188
+ else:
189
+ print(result.data.segments)
190
+ ```
191
+
192
+ ## Retry and timeout
193
+
194
+ The client retries automatically on network errors and `408 / 429 / 500 / 502 / 503 / 504` responses. `429` responses with a `Retry-After` header are respected.
195
+
196
+ ```python
197
+ from nadeshiko import Nadeshiko, RetryOptions
198
+
199
+ client = Nadeshiko(
200
+ api_key=os.environ["NADESHIKO_API_KEY"],
201
+ retry_options=RetryOptions(
202
+ max_retries=3, # default: 2
203
+ initial_delay=1, # default: 0.5 - doubles with each attempt
204
+ max_delay=30, # default: 30
205
+ timeout=10, # per-attempt timeout in seconds (default: none)
206
+ ),
207
+ )
208
+ ```
209
+
210
+ ## Pagination
211
+
212
+ Paginated endpoints have an `iter_*` method that returns an iterator over individual items:
213
+
214
+ ```python
215
+ from nadeshiko.models import SearchQuery
216
+
217
+ for segment in client.iter_search(
218
+ query=SearchQuery(search="猫"),
219
+ ):
220
+ print(segment.text_ja.content)
221
+
222
+ for media in client.iter_list_media():
223
+ print(media.name_en)
224
+ ```
225
+
226
+ For manual page-by-page control, use the `cursor` field:
227
+
228
+ ```python
229
+ from nadeshiko.models import SearchQuery
230
+
231
+ cursor: str | None = None
232
+
233
+ while True:
234
+ data = client.search(
235
+ query=SearchQuery(search="犬"),
236
+ take=10,
237
+ cursor=cursor,
238
+ )
239
+
240
+ for segment in data.segments:
241
+ print(segment.text_ja.content)
242
+
243
+ if not data.pagination.has_more or data.pagination.cursor is None:
244
+ break
245
+
246
+ cursor = data.pagination.cursor
247
+ ```
248
+
249
+ See [`examples/examples.py`](examples/examples.py) for more usage patterns.
@@ -0,0 +1,22 @@
1
+ [build-system]
2
+ requires = ["hatchling"]
3
+ build-backend = "hatchling.build"
4
+
5
+ [project]
6
+ name = "nadeshiko-sdk-py"
7
+ dynamic = ["version"]
8
+ description = "Python SDK for Nadeshiko API (public endpoints only)"
9
+ readme = "README.md"
10
+ license = "MIT"
11
+ requires-python = ">=3.11"
12
+ dependencies = [
13
+ "attrs>=23.0",
14
+ "httpx>=0.27.0",
15
+ "python-dateutil>=2.8.0",
16
+ ]
17
+
18
+ [tool.hatch.version]
19
+ path = "src/nadeshiko/_version.py"
20
+
21
+ [tool.hatch.build.targets.wheel]
22
+ packages = ["src/nadeshiko"]
@@ -0,0 +1,17 @@
1
+ """A client library for accessing the Nadeshiko API."""
2
+
3
+ from ._version import __version__
4
+ from .client import AuthenticatedClient as RawClient
5
+ from .errors import NadeshikoError, UnexpectedStatus
6
+ from .sdk import AsyncNadeshiko, Nadeshiko, RetryOptions, SDKResponse
7
+
8
+ __all__ = (
9
+ "AsyncNadeshiko",
10
+ "Nadeshiko",
11
+ "NadeshikoError",
12
+ "RawClient",
13
+ "RetryOptions",
14
+ "SDKResponse",
15
+ "UnexpectedStatus",
16
+ "__version__",
17
+ )
@@ -0,0 +1,45 @@
1
+ from __future__ import annotations
2
+
3
+ from dataclasses import dataclass
4
+
5
+
6
+ @dataclass(frozen=True)
7
+ class OperationMetadata:
8
+ name: str
9
+ module_path: str
10
+ paginated: bool = False
11
+ doc: str = ''
12
+
13
+
14
+ OPERATIONS: tuple[OperationMetadata, ...] = (
15
+ OperationMetadata(name="add_excluded_media", module_path=".api.user.add_excluded_media", paginated=False, doc="Exclude media from search results"),
16
+ OperationMetadata(name="add_favorite_media", module_path=".api.user.add_favorite_media", paginated=False, doc="Star media"),
17
+ OperationMetadata(name="add_segment_to_collection", module_path=".api.collections.add_segment_to_collection", paginated=False, doc="Add segment to collection"),
18
+ OperationMetadata(name="create_collection", module_path=".api.collections.create_collection", paginated=False, doc="Create collection"),
19
+ OperationMetadata(name="create_user_api_key", module_path=".api.user.create_user_api_key", paginated=False, doc="Create an API key with chosen scopes"),
20
+ OperationMetadata(name="delete_collection", module_path=".api.collections.delete_collection", paginated=False, doc="Delete collection"),
21
+ OperationMetadata(name="get_collection", module_path=".api.collections.get_collection", paginated=False, doc="Get collection details"),
22
+ OperationMetadata(name="get_episode", module_path=".api.media.get_episode", paginated=False, doc="Get single episode"),
23
+ OperationMetadata(name="get_me", module_path=".api.user.get_me", paginated=False, doc="Get current user profile"),
24
+ OperationMetadata(name="get_media", module_path=".api.media.get_media", paginated=False, doc="Get single media"),
25
+ OperationMetadata(name="get_search_stats", module_path=".api.search.get_search_stats", paginated=False, doc="Get search statistics"),
26
+ OperationMetadata(name="get_segment", module_path=".api.media.get_segment", paginated=False, doc="Get single segment"),
27
+ OperationMetadata(name="get_segment_context", module_path=".api.media.get_segment_context", paginated=False, doc="Get surrounding context for a segment"),
28
+ OperationMetadata(name="get_stats_overview", module_path=".api.stats.get_stats_overview", paginated=False, doc="Get corpus statistics overview"),
29
+ OperationMetadata(name="get_user_activity_heatmap", module_path=".api.activity.get_user_activity_heatmap", paginated=False, doc="Get activity heatmap data"),
30
+ OperationMetadata(name="get_user_activity_stats", module_path=".api.activity.get_user_activity_stats", paginated=False, doc="Get user activity statistics"),
31
+ OperationMetadata(name="list_collections", module_path=".api.collections.list_collections", paginated=True, doc="List collections"),
32
+ OperationMetadata(name="list_episodes", module_path=".api.media.list_episodes", paginated=True, doc="List episodes for a media"),
33
+ OperationMetadata(name="list_excluded_media", module_path=".api.user.list_excluded_media", paginated=False, doc="List excluded media"),
34
+ OperationMetadata(name="list_familiar_media", module_path=".api.activity.list_familiar_media", paginated=False, doc="List the titles the reader studies most"),
35
+ OperationMetadata(name="list_favorite_media", module_path=".api.user.list_favorite_media", paginated=False, doc="List starred media"),
36
+ OperationMetadata(name="list_media", module_path=".api.media.list_media", paginated=True, doc="List all media"),
37
+ OperationMetadata(name="list_user_activity", module_path=".api.activity.list_user_activity", paginated=True, doc="List user activity"),
38
+ OperationMetadata(name="remove_excluded_media", module_path=".api.user.remove_excluded_media", paginated=False, doc="Remove media from excluded list"),
39
+ OperationMetadata(name="remove_favorite_media", module_path=".api.user.remove_favorite_media", paginated=False, doc="Unstar media"),
40
+ OperationMetadata(name="remove_segment_from_collection", module_path=".api.collections.remove_segment_from_collection", paginated=False, doc="Remove segment from collection"),
41
+ OperationMetadata(name="search", module_path=".api.search.search", paginated=True, doc="Search segments by query"),
42
+ OperationMetadata(name="search_collection_segments", module_path=".api.collections.search_collection_segments", paginated=True, doc="Search segments in a collection"),
43
+ OperationMetadata(name="search_media", module_path=".api.search.search_media", paginated=False, doc="Find media by name"),
44
+ OperationMetadata(name="search_words", module_path=".api.search.search_words", paginated=False, doc="Search by multiple words"),
45
+ )
@@ -0,0 +1 @@
1
+ __version__ = "2.6.0"
@@ -0,0 +1 @@
1
+ """Contains methods for accessing the API"""
@@ -0,0 +1 @@
1
+ """Contains endpoint functions for accessing the API"""