progressbar2 4.5.0__tar.gz → 4.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 (365) hide show
  1. progressbar2-4.5.0/ISSUE_TEMPLATE → progressbar2-4.6.0/.github/ISSUE_TEMPLATE.md +0 -1
  2. {progressbar2-4.5.0 → progressbar2-4.6.0}/.github/workflows/codeql.yml +6 -6
  3. progressbar2-4.6.0/.github/workflows/docs.yml +45 -0
  4. progressbar2-4.6.0/.github/workflows/main.yml +113 -0
  5. {progressbar2-4.5.0 → progressbar2-4.6.0}/.github/workflows/stale.yml +3 -1
  6. {progressbar2-4.5.0 → progressbar2-4.6.0}/.gitignore +6 -0
  7. progressbar2-4.6.0/.npmrc +3 -0
  8. {progressbar2-4.5.0 → progressbar2-4.6.0}/.pre-commit-config.yaml +6 -4
  9. {progressbar2-4.5.0 → progressbar2-4.6.0}/.readthedocs.yaml +14 -2
  10. progressbar2-4.6.0/AGENTS.md +16 -0
  11. {progressbar2-4.5.0 → progressbar2-4.6.0}/CHANGES.rst +1 -1
  12. progressbar2-4.6.0/CONTRIBUTING.rst +163 -0
  13. {progressbar2-4.5.0 → progressbar2-4.6.0}/LICENSE +0 -1
  14. {progressbar2-4.5.0 → progressbar2-4.6.0}/MANIFEST.in +0 -4
  15. progressbar2-4.6.0/PKG-INFO +272 -0
  16. progressbar2-4.6.0/README.rst +185 -0
  17. progressbar2-4.6.0/benchmarks/bench.py +348 -0
  18. progressbar2-4.6.0/benchmarks/chart.png +0 -0
  19. progressbar2-4.6.0/benchmarks/report.md +83 -0
  20. progressbar2-4.6.0/benchmarks/report.py +402 -0
  21. progressbar2-4.6.0/benchmarks/requirements.txt +5 -0
  22. progressbar2-4.6.0/benchmarks/results.json +107 -0
  23. progressbar2-4.6.0/docs/_ext/demo.py +165 -0
  24. progressbar2-4.6.0/docs/_static/demos/howto-colors.svg +60 -0
  25. progressbar2-4.6.0/docs/_static/demos/howto-custom-widget.svg +60 -0
  26. progressbar2-4.6.0/docs/_static/demos/howto-dynamic-messages.svg +60 -0
  27. progressbar2-4.6.0/docs/_static/demos/howto-file-transfer.svg +60 -0
  28. progressbar2-4.6.0/docs/_static/demos/howto-iterable-wrapper.svg +60 -0
  29. progressbar2-4.6.0/docs/_static/demos/howto-logging-integration.svg +60 -0
  30. progressbar2-4.6.0/docs/_static/demos/howto-multibar-line-offset.svg +60 -0
  31. progressbar2-4.6.0/docs/_static/demos/howto-multibar.svg +60 -0
  32. progressbar2-4.6.0/docs/_static/demos/howto-non-tty.svg +60 -0
  33. progressbar2-4.6.0/docs/_static/demos/howto-prefix-suffix.svg +60 -0
  34. progressbar2-4.6.0/docs/_static/demos/howto-redirect-stdout.svg +60 -0
  35. progressbar2-4.6.0/docs/_static/demos/howto-tqdm-style.svg +60 -0
  36. progressbar2-4.6.0/docs/_static/demos/howto-unknown-length.svg +60 -0
  37. progressbar2-4.6.0/docs/_static/demos/readme-hero.svg +60 -0
  38. progressbar2-4.6.0/docs/_static/demos/readme-multibar.svg +60 -0
  39. progressbar2-4.6.0/docs/_static/demos/readme-unknown-length.svg +60 -0
  40. progressbar2-4.6.0/docs/_static/demos/tutorial-step1.svg +60 -0
  41. progressbar2-4.6.0/docs/_static/demos/tutorial-step2.svg +60 -0
  42. progressbar2-4.6.0/docs/_static/demos/tutorial-step3.svg +60 -0
  43. progressbar2-4.6.0/docs/_static/demos/tutorial-step4.svg +60 -0
  44. progressbar2-4.6.0/docs/_static/demos/tutorial-step5.svg +60 -0
  45. progressbar2-4.6.0/docs/_static/demos/widgets-absolute-eta.svg +60 -0
  46. progressbar2-4.6.0/docs/_static/demos/widgets-adaptive-eta.svg +60 -0
  47. progressbar2-4.6.0/docs/_static/demos/widgets-adaptive-transfer-speed.svg +60 -0
  48. progressbar2-4.6.0/docs/_static/demos/widgets-animated-marker.svg +60 -0
  49. progressbar2-4.6.0/docs/_static/demos/widgets-bar.svg +60 -0
  50. progressbar2-4.6.0/docs/_static/demos/widgets-bouncing-bar.svg +60 -0
  51. progressbar2-4.6.0/docs/_static/demos/widgets-counter.svg +60 -0
  52. progressbar2-4.6.0/docs/_static/demos/widgets-current-time.svg +60 -0
  53. progressbar2-4.6.0/docs/_static/demos/widgets-data-size.svg +60 -0
  54. progressbar2-4.6.0/docs/_static/demos/widgets-dynamic-message.svg +60 -0
  55. progressbar2-4.6.0/docs/_static/demos/widgets-eta.svg +60 -0
  56. progressbar2-4.6.0/docs/_static/demos/widgets-file-transfer-speed.svg +60 -0
  57. progressbar2-4.6.0/docs/_static/demos/widgets-format-custom-text.svg +60 -0
  58. progressbar2-4.6.0/docs/_static/demos/widgets-format-label-bar.svg +60 -0
  59. progressbar2-4.6.0/docs/_static/demos/widgets-format-label.svg +60 -0
  60. progressbar2-4.6.0/docs/_static/demos/widgets-granular-bar.svg +60 -0
  61. progressbar2-4.6.0/docs/_static/demos/widgets-job-status-bar.svg +60 -0
  62. progressbar2-4.6.0/docs/_static/demos/widgets-multi-progress-bar.svg +60 -0
  63. progressbar2-4.6.0/docs/_static/demos/widgets-multi-range-bar.svg +60 -0
  64. progressbar2-4.6.0/docs/_static/demos/widgets-percentage-label-bar.svg +60 -0
  65. progressbar2-4.6.0/docs/_static/demos/widgets-percentage.svg +60 -0
  66. progressbar2-4.6.0/docs/_static/demos/widgets-postfix.svg +60 -0
  67. progressbar2-4.6.0/docs/_static/demos/widgets-reverse-bar.svg +60 -0
  68. progressbar2-4.6.0/docs/_static/demos/widgets-rotating-marker.svg +60 -0
  69. progressbar2-4.6.0/docs/_static/demos/widgets-simple-progress.svg +60 -0
  70. progressbar2-4.6.0/docs/_static/demos/widgets-smoothing-eta.svg +60 -0
  71. progressbar2-4.6.0/docs/_static/demos/widgets-timer.svg +60 -0
  72. progressbar2-4.6.0/docs/_static/demos/widgets-unit-progress.svg +60 -0
  73. progressbar2-4.6.0/docs/_static/demos/widgets-variable.svg +60 -0
  74. progressbar2-4.6.0/docs/_static/livecode/livecode.css +75 -0
  75. progressbar2-4.6.0/docs/_static/livecode/livecode.js +201 -0
  76. progressbar2-4.6.0/docs/_static/livecode/worker.js +207 -0
  77. progressbar2-4.6.0/docs/_static/vendor/LICENSE-xterm.txt +21 -0
  78. progressbar2-4.6.0/docs/_static/vendor/README.md +16 -0
  79. progressbar2-4.6.0/docs/_static/vendor/xterm.css +218 -0
  80. progressbar2-4.6.0/docs/_static/vendor/xterm.js +2 -0
  81. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/conf.py +46 -6
  82. progressbar2-4.6.0/docs/examples/__init__.py +22 -0
  83. progressbar2-4.6.0/docs/examples/_loader.py +27 -0
  84. progressbar2-4.6.0/docs/examples/_registry.py +131 -0
  85. progressbar2-4.6.0/docs/examples/howto/__init__.py +0 -0
  86. progressbar2-4.6.0/docs/examples/howto/colors.py +52 -0
  87. progressbar2-4.6.0/docs/examples/howto/custom_widget.py +49 -0
  88. progressbar2-4.6.0/docs/examples/howto/dynamic_messages.py +39 -0
  89. progressbar2-4.6.0/docs/examples/howto/file_transfer.py +45 -0
  90. progressbar2-4.6.0/docs/examples/howto/iterable_wrapper.py +28 -0
  91. progressbar2-4.6.0/docs/examples/howto/logging_integration.py +56 -0
  92. progressbar2-4.6.0/docs/examples/howto/multibar.py +46 -0
  93. progressbar2-4.6.0/docs/examples/howto/multibar_line_offset.py +43 -0
  94. progressbar2-4.6.0/docs/examples/howto/non_tty.py +32 -0
  95. progressbar2-4.6.0/docs/examples/howto/prefix_suffix.py +32 -0
  96. progressbar2-4.6.0/docs/examples/howto/redirect_stdout.py +32 -0
  97. progressbar2-4.6.0/docs/examples/howto/tqdm_style.py +42 -0
  98. progressbar2-4.6.0/docs/examples/howto/unknown_length.py +34 -0
  99. progressbar2-4.6.0/docs/examples/readme/__init__.py +0 -0
  100. progressbar2-4.6.0/docs/examples/readme/hero.py +28 -0
  101. progressbar2-4.6.0/docs/examples/readme/multibar.py +35 -0
  102. progressbar2-4.6.0/docs/examples/readme/unknown_length.py +22 -0
  103. progressbar2-4.6.0/docs/examples/tutorial/__init__.py +0 -0
  104. progressbar2-4.6.0/docs/examples/tutorial/step1.py +21 -0
  105. progressbar2-4.6.0/docs/examples/tutorial/step2.py +24 -0
  106. progressbar2-4.6.0/docs/examples/tutorial/step3.py +23 -0
  107. progressbar2-4.6.0/docs/examples/tutorial/step4.py +30 -0
  108. progressbar2-4.6.0/docs/examples/tutorial/step5.py +34 -0
  109. progressbar2-4.6.0/docs/examples/widgets/__init__.py +0 -0
  110. progressbar2-4.6.0/docs/examples/widgets/absolute_eta.py +36 -0
  111. progressbar2-4.6.0/docs/examples/widgets/adaptive_eta.py +39 -0
  112. progressbar2-4.6.0/docs/examples/widgets/adaptive_transfer_speed.py +41 -0
  113. progressbar2-4.6.0/docs/examples/widgets/animated_marker.py +27 -0
  114. progressbar2-4.6.0/docs/examples/widgets/bar.py +27 -0
  115. progressbar2-4.6.0/docs/examples/widgets/bouncing_bar.py +33 -0
  116. progressbar2-4.6.0/docs/examples/widgets/counter.py +27 -0
  117. progressbar2-4.6.0/docs/examples/widgets/current_time.py +31 -0
  118. progressbar2-4.6.0/docs/examples/widgets/data_size.py +28 -0
  119. progressbar2-4.6.0/docs/examples/widgets/dynamic_message.py +37 -0
  120. progressbar2-4.6.0/docs/examples/widgets/eta.py +41 -0
  121. progressbar2-4.6.0/docs/examples/widgets/file_transfer_speed.py +34 -0
  122. progressbar2-4.6.0/docs/examples/widgets/format_custom_text.py +31 -0
  123. progressbar2-4.6.0/docs/examples/widgets/format_label.py +30 -0
  124. progressbar2-4.6.0/docs/examples/widgets/format_label_bar.py +27 -0
  125. progressbar2-4.6.0/docs/examples/widgets/granular_bar.py +31 -0
  126. progressbar2-4.6.0/docs/examples/widgets/job_status_bar.py +36 -0
  127. progressbar2-4.6.0/docs/examples/widgets/multi_progress_bar.py +48 -0
  128. progressbar2-4.6.0/docs/examples/widgets/multi_range_bar.py +51 -0
  129. progressbar2-4.6.0/docs/examples/widgets/percentage.py +27 -0
  130. progressbar2-4.6.0/docs/examples/widgets/percentage_label_bar.py +27 -0
  131. progressbar2-4.6.0/docs/examples/widgets/postfix.py +40 -0
  132. progressbar2-4.6.0/docs/examples/widgets/reverse_bar.py +26 -0
  133. progressbar2-4.6.0/docs/examples/widgets/rotating_marker.py +30 -0
  134. progressbar2-4.6.0/docs/examples/widgets/simple_progress.py +26 -0
  135. progressbar2-4.6.0/docs/examples/widgets/smoothing_eta.py +40 -0
  136. progressbar2-4.6.0/docs/examples/widgets/timer.py +32 -0
  137. progressbar2-4.6.0/docs/examples/widgets/unit_progress.py +27 -0
  138. progressbar2-4.6.0/docs/examples/widgets/variable.py +39 -0
  139. progressbar2-4.6.0/docs/examples.rst +8 -0
  140. progressbar2-4.6.0/docs/explanation/backwards-compatibility.rst +87 -0
  141. progressbar2-4.6.0/docs/explanation/index.rst +13 -0
  142. progressbar2-4.6.0/docs/explanation/performance-and-the-fast-path.rst +117 -0
  143. progressbar2-4.6.0/docs/explanation/rendering-and-the-update-gate.rst +99 -0
  144. progressbar2-4.6.0/docs/explanation/terminal-detection.rst +120 -0
  145. progressbar2-4.6.0/docs/howto/colors.rst +27 -0
  146. progressbar2-4.6.0/docs/howto/custom-widget.rst +18 -0
  147. progressbar2-4.6.0/docs/howto/dynamic-messages.rst +20 -0
  148. progressbar2-4.6.0/docs/howto/file-transfer.rst +17 -0
  149. progressbar2-4.6.0/docs/howto/index.rst +23 -0
  150. progressbar2-4.6.0/docs/howto/iterable-wrapper.rst +17 -0
  151. progressbar2-4.6.0/docs/howto/logging-integration.rst +37 -0
  152. progressbar2-4.6.0/docs/howto/multibar-line-offset.rst +34 -0
  153. progressbar2-4.6.0/docs/howto/multibar.rst +32 -0
  154. progressbar2-4.6.0/docs/howto/non-tty.rst +18 -0
  155. progressbar2-4.6.0/docs/howto/prefix-suffix.rst +17 -0
  156. progressbar2-4.6.0/docs/howto/redirect-stdout.rst +16 -0
  157. progressbar2-4.6.0/docs/howto/tqdm-style.rst +25 -0
  158. progressbar2-4.6.0/docs/howto/unknown-length.rst +15 -0
  159. progressbar2-4.6.0/docs/index.rst +54 -0
  160. progressbar2-4.6.0/docs/installation.rst +32 -0
  161. progressbar2-4.6.0/docs/major-version-backlog.md +107 -0
  162. progressbar2-4.6.0/docs/progressbar.fast.rst +7 -0
  163. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.rst +3 -0
  164. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.terminal.rst +0 -8
  165. progressbar2-4.6.0/docs/reference/cli.rst +144 -0
  166. progressbar2-4.6.0/docs/reference/index.rst +13 -0
  167. progressbar2-4.6.0/docs/reference/multibar.rst +76 -0
  168. progressbar2-4.6.0/docs/reference/progressbar.rst +118 -0
  169. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/requirements.txt +1 -0
  170. progressbar2-4.6.0/docs/tutorial/index.rst +15 -0
  171. progressbar2-4.6.0/docs/tutorial/step1.rst +25 -0
  172. progressbar2-4.6.0/docs/tutorial/step2.rst +21 -0
  173. progressbar2-4.6.0/docs/tutorial/step3.rst +19 -0
  174. progressbar2-4.6.0/docs/tutorial/step4.rst +19 -0
  175. progressbar2-4.6.0/docs/tutorial/step5.rst +28 -0
  176. progressbar2-4.6.0/docs/usage.rst +11 -0
  177. progressbar2-4.6.0/docs/widgets/absolute-eta.rst +27 -0
  178. progressbar2-4.6.0/docs/widgets/adaptive-eta.rst +31 -0
  179. progressbar2-4.6.0/docs/widgets/adaptive-transfer-speed.rst +25 -0
  180. progressbar2-4.6.0/docs/widgets/animated-marker.rst +27 -0
  181. progressbar2-4.6.0/docs/widgets/bar.rst +27 -0
  182. progressbar2-4.6.0/docs/widgets/bouncing-bar.rst +27 -0
  183. progressbar2-4.6.0/docs/widgets/counter.rst +25 -0
  184. progressbar2-4.6.0/docs/widgets/current-time.rst +26 -0
  185. progressbar2-4.6.0/docs/widgets/data-size.rst +25 -0
  186. progressbar2-4.6.0/docs/widgets/dynamic-message.rst +23 -0
  187. progressbar2-4.6.0/docs/widgets/eta.rst +29 -0
  188. progressbar2-4.6.0/docs/widgets/file-transfer-speed.rst +26 -0
  189. progressbar2-4.6.0/docs/widgets/format-custom-text.rst +25 -0
  190. progressbar2-4.6.0/docs/widgets/format-label-bar.rst +26 -0
  191. progressbar2-4.6.0/docs/widgets/format-label.rst +26 -0
  192. progressbar2-4.6.0/docs/widgets/granular-bar.rst +25 -0
  193. progressbar2-4.6.0/docs/widgets/index.rst +137 -0
  194. progressbar2-4.6.0/docs/widgets/job-status-bar.rst +28 -0
  195. progressbar2-4.6.0/docs/widgets/multi-progress-bar.rst +26 -0
  196. progressbar2-4.6.0/docs/widgets/multi-range-bar.rst +30 -0
  197. progressbar2-4.6.0/docs/widgets/percentage-label-bar.rst +26 -0
  198. progressbar2-4.6.0/docs/widgets/percentage.rst +25 -0
  199. progressbar2-4.6.0/docs/widgets/postfix.rst +25 -0
  200. progressbar2-4.6.0/docs/widgets/reverse-bar.rst +23 -0
  201. progressbar2-4.6.0/docs/widgets/rotating-marker.rst +24 -0
  202. progressbar2-4.6.0/docs/widgets/simple-progress.rst +26 -0
  203. progressbar2-4.6.0/docs/widgets/smoothing-eta.rst +30 -0
  204. progressbar2-4.6.0/docs/widgets/timer.rst +27 -0
  205. progressbar2-4.6.0/docs/widgets/unit-progress.rst +26 -0
  206. progressbar2-4.6.0/docs/widgets/variable.rst +26 -0
  207. progressbar2-4.6.0/examples.py +81 -0
  208. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar/__about__.py +5 -3
  209. progressbar2-4.6.0/progressbar/__init__.py +205 -0
  210. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar/__main__.py +192 -62
  211. progressbar2-4.6.0/progressbar/algorithms.py +112 -0
  212. progressbar2-4.6.0/progressbar/bar.py +1795 -0
  213. progressbar2-4.6.0/progressbar/base.py +51 -0
  214. progressbar2-4.6.0/progressbar/env.py +297 -0
  215. progressbar2-4.6.0/progressbar/fast.py +131 -0
  216. progressbar2-4.6.0/progressbar/multi.py +712 -0
  217. progressbar2-4.6.0/progressbar/py.typed +0 -0
  218. progressbar2-4.6.0/progressbar/shortcuts.py +108 -0
  219. progressbar2-4.6.0/progressbar/terminal/__init__.py +12 -0
  220. progressbar2-4.6.0/progressbar/terminal/base.py +1001 -0
  221. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar/terminal/colors.py +184 -155
  222. progressbar2-4.6.0/progressbar/terminal/os_specific/__init__.py +51 -0
  223. progressbar2-4.6.0/progressbar/terminal/os_specific/posix.py +39 -0
  224. progressbar2-4.6.0/progressbar/terminal/os_specific/windows.py +316 -0
  225. progressbar2-4.6.0/progressbar/terminal/stream.py +241 -0
  226. progressbar2-4.6.0/progressbar/utils.py +865 -0
  227. progressbar2-4.6.0/progressbar/widgets.py +2285 -0
  228. progressbar2-4.6.0/progressbar2.egg-info/PKG-INFO +272 -0
  229. progressbar2-4.6.0/progressbar2.egg-info/SOURCES.txt +313 -0
  230. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar2.egg-info/requires.txt +7 -3
  231. progressbar2-4.6.0/progressbar2.egg-info/top_level.txt +1 -0
  232. {progressbar2-4.5.0 → progressbar2-4.6.0}/pyproject.toml +112 -73
  233. progressbar2-4.6.0/pytest.ini +35 -0
  234. {progressbar2-4.5.0 → progressbar2-4.6.0}/ruff.toml +29 -11
  235. progressbar2-4.6.0/scripts/__init__.py +1 -0
  236. progressbar2-4.6.0/scripts/build_docs_wheels.py +148 -0
  237. progressbar2-4.6.0/scripts/render_demos.py +900 -0
  238. progressbar2-4.6.0/tests/api_surface_snapshot.json +544 -0
  239. progressbar2-4.6.0/tests/conftest.py +80 -0
  240. progressbar2-4.6.0/tests/console/__init__.py +0 -0
  241. progressbar2-4.6.0/tests/console/test_console.py +333 -0
  242. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/original_examples.py +1 -1
  243. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_algorithms.py +26 -4
  244. progressbar2-4.6.0/tests/test_api_surface.py +178 -0
  245. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_color.py +199 -9
  246. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_custom_widgets.py +36 -0
  247. progressbar2-4.6.0/tests/test_data_transfer_bar.py +31 -0
  248. progressbar2-4.6.0/tests/test_docs_examples.py +265 -0
  249. progressbar2-4.6.0/tests/test_env_detection.py +95 -0
  250. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_failure.py +50 -0
  251. progressbar2-4.6.0/tests/test_fast_default.py +250 -0
  252. progressbar2-4.6.0/tests/test_fastpath.py +620 -0
  253. progressbar2-4.6.0/tests/test_init_exports.py +63 -0
  254. progressbar2-4.6.0/tests/test_job_status.py +87 -0
  255. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_monitor_progress.py +15 -22
  256. progressbar2-4.6.0/tests/test_multibar.py +579 -0
  257. progressbar2-4.6.0/tests/test_native_accelerator.py +286 -0
  258. progressbar2-4.6.0/tests/test_needs_update.py +93 -0
  259. progressbar2-4.6.0/tests/test_os_specific.py +17 -0
  260. progressbar2-4.6.0/tests/test_os_specific_posix.py +49 -0
  261. progressbar2-4.6.0/tests/test_perf_budget.py +84 -0
  262. progressbar2-4.6.0/tests/test_progressbar.py +373 -0
  263. progressbar2-4.6.0/tests/test_progressbar_command.py +290 -0
  264. progressbar2-4.6.0/tests/test_readme_demos.py +918 -0
  265. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_samples.py +17 -0
  266. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_speed.py +3 -1
  267. progressbar2-4.6.0/tests/test_stream.py +558 -0
  268. progressbar2-4.6.0/tests/test_subclass_compat.py +493 -0
  269. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_terminal.py +51 -0
  270. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_timed.py +23 -0
  271. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_unknown_length.py +20 -0
  272. progressbar2-4.6.0/tests/test_update_guard.py +48 -0
  273. progressbar2-4.6.0/tests/test_utils.py +290 -0
  274. progressbar2-4.6.0/tests/test_widgets.py +485 -0
  275. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_windows.py +27 -0
  276. progressbar2-4.6.0/tests/test_with.py +65 -0
  277. progressbar2-4.6.0/tools/README.md +17 -0
  278. progressbar2-4.6.0/tools/generate_colors.py +207 -0
  279. progressbar2-4.6.0/tox.ini +75 -0
  280. progressbar2-4.6.0/uv.lock +1272 -0
  281. progressbar2-4.5.0/.github/workflows/main.yml +0 -26
  282. progressbar2-4.5.0/CONTRIBUTING.rst +0 -126
  283. progressbar2-4.5.0/Makefile +0 -51
  284. progressbar2-4.5.0/PKG-INFO +0 -435
  285. progressbar2-4.5.0/README.rst +0 -353
  286. progressbar2-4.5.0/appveyor.yml +0 -41
  287. progressbar2-4.5.0/circle.yml +0 -8
  288. progressbar2-4.5.0/docs/_theme/LICENSE +0 -46
  289. progressbar2-4.5.0/docs/_theme/flask_theme_support.py +0 -89
  290. progressbar2-4.5.0/docs/_theme/wolph/layout.html +0 -27
  291. progressbar2-4.5.0/docs/_theme/wolph/relations.html +0 -19
  292. progressbar2-4.5.0/docs/_theme/wolph/static/flasky.css_t +0 -431
  293. progressbar2-4.5.0/docs/_theme/wolph/static/small_flask.css +0 -70
  294. progressbar2-4.5.0/docs/_theme/wolph/theme.conf +0 -7
  295. progressbar2-4.5.0/docs/examples.rst +0 -5
  296. progressbar2-4.5.0/docs/index.rst +0 -28
  297. progressbar2-4.5.0/docs/installation.rst +0 -16
  298. progressbar2-4.5.0/docs/usage.rst +0 -70
  299. progressbar2-4.5.0/examples.py +0 -866
  300. progressbar2-4.5.0/progressbar/__init__.py +0 -91
  301. progressbar2-4.5.0/progressbar/algorithms.py +0 -51
  302. progressbar2-4.5.0/progressbar/bar.py +0 -1147
  303. progressbar2-4.5.0/progressbar/base.py +0 -36
  304. progressbar2-4.5.0/progressbar/env.py +0 -189
  305. progressbar2-4.5.0/progressbar/multi.py +0 -373
  306. progressbar2-4.5.0/progressbar/shortcuts.py +0 -22
  307. progressbar2-4.5.0/progressbar/terminal/__init__.py +0 -4
  308. progressbar2-4.5.0/progressbar/terminal/base.py +0 -623
  309. progressbar2-4.5.0/progressbar/terminal/os_specific/__init__.py +0 -27
  310. progressbar2-4.5.0/progressbar/terminal/os_specific/posix.py +0 -15
  311. progressbar2-4.5.0/progressbar/terminal/os_specific/windows.py +0 -174
  312. progressbar2-4.5.0/progressbar/terminal/stream.py +0 -142
  313. progressbar2-4.5.0/progressbar/utils.py +0 -450
  314. progressbar2-4.5.0/progressbar/widgets.py +0 -1619
  315. progressbar2-4.5.0/progressbar2.egg-info/PKG-INFO +0 -435
  316. progressbar2-4.5.0/progressbar2.egg-info/SOURCES.txt +0 -114
  317. progressbar2-4.5.0/progressbar2.egg-info/top_level.txt +0 -4
  318. progressbar2-4.5.0/pytest.ini +0 -28
  319. progressbar2-4.5.0/requirements.txt +0 -2
  320. progressbar2-4.5.0/tests/conftest.py +0 -49
  321. progressbar2-4.5.0/tests/test_data_transfer_bar.py +0 -16
  322. progressbar2-4.5.0/tests/test_job_status.py +0 -22
  323. progressbar2-4.5.0/tests/test_multibar.py +0 -249
  324. progressbar2-4.5.0/tests/test_progressbar.py +0 -78
  325. progressbar2-4.5.0/tests/test_progressbar_command.py +0 -144
  326. progressbar2-4.5.0/tests/test_stream.py +0 -150
  327. progressbar2-4.5.0/tests/test_utils.py +0 -114
  328. progressbar2-4.5.0/tests/test_widgets.py +0 -206
  329. progressbar2-4.5.0/tests/test_with.py +0 -19
  330. progressbar2-4.5.0/tox.ini +0 -65
  331. {progressbar2-4.5.0 → progressbar2-4.6.0}/.github/FUNDING.yml +0 -0
  332. {progressbar2-4.5.0 → progressbar2-4.6.0}/.github/ci-reporter.yml +0 -0
  333. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/.gitignore +0 -0
  334. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/Makefile +0 -0
  335. /progressbar2-4.5.0/progressbar/py.typed → /progressbar2-4.6.0/docs/_ext/__init__.py +0 -0
  336. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/contributing.rst +0 -0
  337. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/history.rst +0 -0
  338. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/make.bat +0 -0
  339. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.algorithms.rst +0 -0
  340. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.bar.rst +0 -0
  341. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.base.rst +0 -0
  342. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.env.rst +0 -0
  343. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.multi.rst +0 -0
  344. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.shortcuts.rst +0 -0
  345. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.terminal.base.rst +0 -0
  346. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.terminal.colors.rst +0 -0
  347. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.terminal.stream.rst +0 -0
  348. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.utils.rst +0 -0
  349. {progressbar2-4.5.0 → progressbar2-4.6.0}/docs/progressbar.widgets.rst +0 -0
  350. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar2.egg-info/dependency_links.txt +0 -0
  351. {progressbar2-4.5.0 → progressbar2-4.6.0}/progressbar2.egg-info/entry_points.txt +0 -0
  352. {progressbar2-4.5.0 → progressbar2-4.6.0}/setup.cfg +0 -0
  353. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/requirements.txt +0 -0
  354. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_backwards_compatibility.py +0 -0
  355. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_data.py +0 -0
  356. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_dill_pickle.py +0 -0
  357. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_empty.py +0 -0
  358. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_end.py +0 -0
  359. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_flush.py +0 -0
  360. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_iterators.py +0 -0
  361. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_large_values.py +0 -0
  362. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_misc.py +0 -0
  363. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_timer.py +0 -0
  364. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_unicode.py +0 -0
  365. {progressbar2-4.5.0 → progressbar2-4.6.0}/tests/test_wrappingio.py +0 -0
@@ -12,4 +12,3 @@ If applicable, code to reproduce the issue and/or the stacktrace of the issue
12
12
  - Python distribution/environment: CPython/Anaconda/IPython/IDLE
13
13
  - Operating System: Windows 10, Ubuntu Linux, etc.
14
14
  - Package version: `import progressbar; print(progressbar.__version__)`
15
-
@@ -20,23 +20,23 @@ jobs:
20
20
  strategy:
21
21
  fail-fast: false
22
22
  matrix:
23
- language: [ python, javascript ]
23
+ language: [ python ]
24
24
 
25
25
  steps:
26
26
  - name: Checkout
27
- uses: actions/checkout@v3
27
+ uses: actions/checkout@v6
28
28
 
29
29
  - name: Initialize CodeQL
30
- uses: github/codeql-action/init@v2
30
+ uses: github/codeql-action/init@v3
31
31
  with:
32
32
  languages: ${{ matrix.language }}
33
33
  queries: +security-and-quality
34
34
 
35
35
  - name: Autobuild
36
- uses: github/codeql-action/autobuild@v2
37
- if: ${{ matrix.language == 'python' || matrix.language == 'javascript' }}
36
+ uses: github/codeql-action/autobuild@v3
37
+ if: ${{ matrix.language == 'python' }}
38
38
 
39
39
  - name: Perform CodeQL Analysis
40
- uses: github/codeql-action/analyze@v2
40
+ uses: github/codeql-action/analyze@v3
41
41
  with:
42
42
  category: "/language:${{ matrix.language }}"
@@ -0,0 +1,45 @@
1
+ name: docs console
2
+
3
+ on:
4
+ push:
5
+ branches: [develop]
6
+ pull_request:
7
+ workflow_dispatch:
8
+
9
+ concurrency:
10
+ group: "${{ github.workflow }}-${{ github.ref }}"
11
+ cancel-in-progress: true
12
+
13
+ permissions:
14
+ contents: read
15
+
16
+ jobs:
17
+ console:
18
+ name: in-browser console smoke test
19
+ runs-on: ubuntu-latest
20
+ # Task 18's wheel build, a real Pyodide runtime download from jsdelivr,
21
+ # and Chromium's own download can all be slow on a cold CI cache; 20
22
+ # minutes leaves headroom without letting a genuine hang run forever.
23
+ timeout-minutes: 20
24
+ steps:
25
+ - uses: actions/checkout@v6
26
+ - name: Set up Python 3.13
27
+ uses: actions/setup-python@v6
28
+ with:
29
+ python-version: '3.13'
30
+ - name: Install dependencies
31
+ run: |
32
+ python -m pip install --upgrade pip tox
33
+ python -m pip install -e '.[docs-tests]'
34
+ python -m playwright install --with-deps chromium
35
+ - name: Build the docs
36
+ run: tox -e docs
37
+ - name: Run the console smoke test
38
+ run: python -m pytest tests/console -v --no-cov
39
+ - name: Upload the built docs
40
+ if: always()
41
+ uses: actions/upload-artifact@v4
42
+ with:
43
+ name: docs-html
44
+ path: docs/_build/html
45
+ retention-days: 7
@@ -0,0 +1,113 @@
1
+ name: tox
2
+
3
+ on:
4
+ push:
5
+ branches: [develop]
6
+ pull_request:
7
+ workflow_dispatch:
8
+
9
+ concurrency:
10
+ group: "${{ github.workflow }}-${{ github.ref }}"
11
+ cancel-in-progress: true
12
+
13
+ permissions:
14
+ contents: read
15
+
16
+ jobs:
17
+ perf-budget:
18
+ name: Performance budget
19
+ runs-on: ubuntu-latest
20
+ timeout-minutes: 10
21
+ steps:
22
+ - uses: actions/checkout@v6
23
+ - name: Set up Python 3.13
24
+ uses: actions/setup-python@v6
25
+ with:
26
+ python-version: '3.13'
27
+ - name: Install dependencies
28
+ run: |
29
+ python -m pip install --upgrade pip
30
+ python -m pip install -r tests/requirements.txt
31
+ python -m pip install -e .
32
+ - name: Performance budget
33
+ run: python -m pytest tests/test_perf_budget.py -v --no-cov
34
+
35
+ build:
36
+ name: tox (${{ matrix.tox-env }})
37
+ runs-on: ubuntu-latest
38
+ timeout-minutes: 10
39
+ strategy:
40
+ fail-fast: false
41
+ matrix:
42
+ include:
43
+ - python-version: '3.10'
44
+ tox-env: py310
45
+ - python-version: '3.11'
46
+ tox-env: py311
47
+ - python-version: '3.12'
48
+ tox-env: py312
49
+ - python-version: '3.13'
50
+ tox-env: py313
51
+ - python-version: '3.14'
52
+ tox-env: py314
53
+ # Python 3.15 is a pre-release and currently unsupported by
54
+ # typing_extensions (no released version survives
55
+ # `from typing_extensions import *` on 3.15 because
56
+ # no_type_check_decorator is still listed in __all__ after its
57
+ # removal from typing), which breaks the python_utils import.
58
+ # Failures are advisory until upstream catches up.
59
+ - python-version: '3.15-dev'
60
+ tox-env: py315
61
+ experimental: true
62
+ - python-version: '3.14'
63
+ tox-env: docs
64
+ - python-version: '3.14'
65
+ tox-env: docs-demos
66
+ - python-version: '3.14'
67
+ tox-env: docs-linkcheck
68
+ experimental: true
69
+ - python-version: '3.14'
70
+ tox-env: ruff
71
+ - python-version: '3.14'
72
+ tox-env: codespell
73
+
74
+ steps:
75
+ - uses: actions/checkout@v6
76
+ - name: Set up Python ${{ matrix.python-version }}
77
+ uses: actions/setup-python@v6
78
+ with:
79
+ python-version: ${{ matrix.python-version }}
80
+ allow-prereleases: true
81
+ - name: Install dependencies
82
+ run: |
83
+ python -m pip install --upgrade pip tox
84
+ - name: Test with tox
85
+ # Step-level continue-on-error keeps the job green for
86
+ # experimental (pre-release Python) environments while still
87
+ # showing the failing step in the logs
88
+ continue-on-error: ${{ matrix.experimental || false }}
89
+ run: tox -e ${{ matrix.tox-env }}
90
+
91
+ windows:
92
+ name: tox (windows / py312)
93
+ runs-on: windows-latest
94
+ timeout-minutes: 10
95
+ env:
96
+ # Force UTF-8 I/O so unicode-marker tests (e.g. test_unicode) don't
97
+ # hit UnicodeEncodeError against the legacy Windows code page under
98
+ # pytest's fd-level capture.
99
+ PYTHONUTF8: '1'
100
+ steps:
101
+ - uses: actions/checkout@v6
102
+ - name: Set up Python 3.12
103
+ uses: actions/setup-python@v6
104
+ with:
105
+ python-version: '3.12'
106
+ - name: Install dependencies
107
+ run: |
108
+ python -m pip install --upgrade pip tox
109
+ - name: Test with tox
110
+ # The 100% coverage gate cannot be met on Windows: POSIX-only
111
+ # branches never execute there, so run without the coverage gate
112
+ # (`--no-cov` posarg). Linux jobs still enforce full coverage.
113
+ run: tox -e py312 -- --no-cov
@@ -8,10 +8,12 @@ on:
8
8
  jobs:
9
9
  stale:
10
10
  runs-on: ubuntu-latest
11
+ permissions:
12
+ issues: write
13
+ pull-requests: write
11
14
  steps:
12
15
  - uses: actions/stale@v8
13
16
  with:
14
17
  days-before-issue-stale: 30
15
18
  exempt-issue-labels: in-progress,help-wanted,pinned,security,enhancement
16
19
  exempt-all-assignees: true
17
-
@@ -42,3 +42,9 @@ coverage.xml
42
42
 
43
43
  # Sphinx documentation
44
44
  docs/_build/
45
+
46
+ # Superpowers brainstorming session artifacts
47
+ .superpowers/
48
+
49
+ # Built at docs build time for the in-browser console
50
+ docs/_static/wheels/
@@ -0,0 +1,3 @@
1
+ # Supply-chain safety: refuse dependency versions published less than 14 days ago.
2
+ # Honored by npm >= 11.10; silently ignored by older npm.
3
+ min-release-age=14
@@ -2,13 +2,15 @@
2
2
  # See https://pre-commit.com/hooks.html for more hooks
3
3
  repos:
4
4
  - repo: https://github.com/pre-commit/pre-commit-hooks
5
- rev: v2.4.0
5
+ rev: v6.0.0
6
6
  hooks:
7
+ - id: end-of-file-fixer
7
8
  - id: trailing-whitespace
8
9
  - id: check-yaml
9
10
  - id: check-added-large-files
10
11
 
11
- - repo: https://gitlab.com/pycqa/flake8
12
- rev: 3.7.9
12
+ - repo: https://github.com/astral-sh/ruff-pre-commit
13
+ rev: v0.15.20
13
14
  hooks:
14
- - id: flake8
15
+ - id: ruff-check
16
+ - id: ruff-format
@@ -13,6 +13,12 @@ build:
13
13
  # nodejs: "20"
14
14
  # rust: "1.70"
15
15
  # golang: "1.20"
16
+ jobs:
17
+ # Build the wheels the in-browser console installs. A list, so a
18
+ # future step can be appended here without restructuring this key.
19
+ pre_build:
20
+ - python -m pip install build
21
+ - python scripts/build_docs_wheels.py
16
22
 
17
23
  # Build documentation in the "docs/" directory with Sphinx
18
24
  sphinx:
@@ -20,9 +26,15 @@ sphinx:
20
26
  # You can configure Sphinx to use a different builder, for instance use the dirhtml builder for simpler URLs
21
27
  # builder: "dirhtml"
22
28
  # Fail on all warnings to avoid broken references
23
- # fail_on_warning: true
29
+ fail_on_warning: true
24
30
 
25
- # Optionally build your docs in additional formats such as PDF and ePub
31
+ # PDF and ePub are supported and build warning-free. They are necessarily
32
+ # static: the `.. demo::` directive emits its animation and Run button as
33
+ # HTML-only nodes, so in these formats a demo degrades to its source
34
+ # listing plus surrounding prose -- readable, just not animated.
35
+ # This works because `docs/index.rst` no longer includes `README.rst`;
36
+ # doing so pulled remote SVG badges into every builder, and LaTeX cannot
37
+ # render SVG at all.
26
38
  formats:
27
39
  - pdf
28
40
  - epub
@@ -0,0 +1,16 @@
1
+ <claude-mem-context>
2
+ # Memory Context
3
+
4
+ # [python-progressbar] recent context, 2026-05-11 12:05am GMT+2
5
+
6
+ Legend: 🎯session 🔴bugfix 🟣feature 🔄refactor ✅change 🔵discovery ⚖️decision 🚨security_alert 🔐security_note
7
+ Format: ID TIME TYPE TITLE
8
+ Fetch details: get_observations([IDs]) | Search: mem-search skill
9
+
10
+ Stats: 1 obs (414t read) | 19,980t work | 98% savings
11
+
12
+ ### May 11, 2026
13
+ 2388 12:04a ✅ CI/tox config updated to test Python 3.10–3.15
14
+
15
+ Access 20k tokens of past work via get_observations([IDs]) or mem-search skill.
16
+ </claude-mem-context>
@@ -8,4 +8,4 @@ releases or the commit log:
8
8
  - https://github.com/WoLpH/python-progressbar/releases
9
9
  - https://github.com/WoLpH/python-progressbar/commits/develop
10
10
 
11
- Hint: click on the `...` button to see the change message.
11
+ Hint: the ``...`` button on a commit shows the full change message.
@@ -0,0 +1,163 @@
1
+ ============
2
+ Contributing
3
+ ============
4
+
5
+ Contributions are welcome: bug reports, fixes, features, and
6
+ documentation.
7
+
8
+ Types of Contributions
9
+ ----------------------
10
+
11
+ Report Bugs
12
+ ~~~~~~~~~~~
13
+
14
+ Report bugs at https://github.com/WoLpH/python-progressbar/issues.
15
+
16
+ If you are reporting a bug, please include:
17
+
18
+ * Your operating system name and version.
19
+ * Any details about your local setup that might be helpful in troubleshooting.
20
+ * Detailed steps to reproduce the bug.
21
+
22
+ Fix Bugs
23
+ ~~~~~~~~
24
+
25
+ Look through the GitHub issues for bugs. Anything tagged with "bug"
26
+ is open to whoever wants to implement it.
27
+
28
+ Implement Features
29
+ ~~~~~~~~~~~~~~~~~~
30
+
31
+ Look through the GitHub issues for features. Anything tagged with "feature"
32
+ is open to whoever wants to implement it.
33
+
34
+ Write Documentation
35
+ ~~~~~~~~~~~~~~~~~~~
36
+
37
+ The documentation lives in ``docs/`` and is built with Sphinx. The
38
+ sections below cover the parts of that build that are easy to get wrong.
39
+
40
+ Regenerating the API reference
41
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
42
+
43
+ The ``docs/progressbar*.rst`` pages are generated once with ``sphinx-apidoc`` and then
44
+ committed and hand-maintained, not regenerated on every build. Never pass ``-f``/``--force``
45
+ when running it again: that silently discards hand-added options, such as
46
+ ``docs/progressbar.bar.rst``'s ``:member-order: bysource``. If you add a new module under
47
+ ``progressbar/``, generate its page the same way the rest were generated and link it into
48
+ ``docs/progressbar.rst``'s ``Submodules`` toctree yourself::
49
+
50
+ $ sphinx-apidoc -e -o docs/ progressbar */os_specific/* */six.py
51
+
52
+ The docs build runs with ``-W`` (warnings fail the build), so a page that exists but isn't
53
+ linked into a toctree fails immediately with "document isn't included in any toctree".
54
+ You'll know right away if you forgot this step.
55
+
56
+ Regenerating demo animations
57
+ ~~~~~~~~~~~~~~~~~~~~~~~~~~~~
58
+
59
+ ``python scripts/render_demos.py`` captures each example attached to a pty, so
60
+ it requires a POSIX system. The generated SVGs are committed, and CI regenerates
61
+ and diffs them on Linux, so Windows contributors do not need to run it.
62
+
63
+ Two demos -- ``howto/multibar`` and ``readme/multibar`` -- are excluded from
64
+ that diff (``Demo.drift_check = False`` in ``docs/examples/_registry.py``):
65
+ ``MultiBar`` renders from a background thread that races the main thread's
66
+ updates, so how many redraws land before both bars finish is a real OS
67
+ thread-scheduling outcome, not something this script can pin down. ``--check``
68
+ prints exactly which demos it skipped and why on every run rather than
69
+ silently passing over them. If you change either demo, regenerate its SVG
70
+ (``python scripts/render_demos.py --only readme/multibar``, for instance) and
71
+ hand-verify the result instead of relying on ``--check``.
72
+
73
+ Adding an example
74
+ ~~~~~~~~~~~~~~~~~~
75
+
76
+ 1. Write ``docs/examples/<section>/<name>.py`` with a module docstring, a
77
+ ``main()`` function, and no terminal-forcing arguments.
78
+ 2. Register it in ``docs/examples/_registry.py``.
79
+ 3. Run ``python scripts/render_demos.py --only <section>/<name>``.
80
+ 4. Reference it from a page with ``.. demo:: <section>/<name>``.
81
+
82
+ ``tests/test_docs_examples.py`` fails if an example exists without a registry
83
+ entry or vice versa, and ``tox -e docs-demos`` fails if a committed animation is
84
+ stale.
85
+
86
+ Submit Feedback
87
+ ~~~~~~~~~~~~~~~
88
+
89
+ The best way to send feedback is to file an issue at https://github.com/WoLpH/python-progressbar/issues.
90
+
91
+ If you are proposing a feature:
92
+
93
+ * Explain in detail how it would work.
94
+ * Keep the scope as narrow as possible, to make it easier to implement.
95
+
96
+ Get Started!
97
+ ------------
98
+
99
+ Ready to contribute? Here's how to set up `python-progressbar` for local development.
100
+
101
+ 1. Fork the `python-progressbar` repo on GitHub.
102
+ 2. Clone your fork locally::
103
+
104
+ $ git clone --branch develop git@github.com:your_name_here/python-progressbar.git
105
+
106
+ 3. Install your local copy into a virtualenv. Assuming you have `uv` installed, this is how you set up your fork for local development::
107
+
108
+ $ cd progressbar/
109
+ $ uv sync
110
+
111
+ 4. Create a branch for local development with `git-flow-avh`_::
112
+
113
+ $ git-flow feature start name-of-your-bugfix-or-feature
114
+
115
+ Or without git-flow:
116
+
117
+ $ git checkout -b feature/name-of-your-bugfix-or-feature
118
+
119
+ Now you can make your changes locally.
120
+
121
+ 5. When you're done making changes, check that your changes pass the
122
+ linter and the tests, including other Python versions with tox::
123
+
124
+ $ uv run ruff check progressbar tests
125
+ $ uv run pytest
126
+ $ uv run tox
127
+
128
+ The ``uv sync`` from step 3 already installed all of these.
129
+
130
+ 6. Commit your changes and push your branch to GitHub with `git-flow-avh`_::
131
+
132
+ $ git add .
133
+ $ git commit -m "Your detailed description of your changes."
134
+ $ git-flow feature publish
135
+
136
+ Or without git-flow:
137
+
138
+ $ git add .
139
+ $ git commit -m "Your detailed description of your changes."
140
+ $ git push -u origin feature/name-of-your-bugfix-or-feature
141
+
142
+ 7. Submit a pull request through the GitHub website.
143
+
144
+ Pull Request Guidelines
145
+ -----------------------
146
+
147
+ Before you submit a pull request, check that it meets these guidelines:
148
+
149
+ 1. The pull request should include tests.
150
+ 2. If the pull request adds functionality, the docs should be updated:
151
+ docstrings plus the relevant page under ``docs/``.
152
+ 3. The pull request should work for every supported Python version (see
153
+ ``requires-python`` in ``pyproject.toml``). CI runs the full matrix on
154
+ GitHub Actions for every pull request.
155
+
156
+ Tips
157
+ ----
158
+
159
+ To run a subset of tests::
160
+
161
+ $ uv run pytest tests/some_test.py
162
+
163
+ .. _git-flow-avh: https://github.com/petervanderdoes/gitflow
@@ -25,4 +25,3 @@ DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
25
25
  HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
26
26
  LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
27
27
  OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
28
-
@@ -1,12 +1,8 @@
1
1
  recursive-exclude *.pyc
2
2
  recursive-exclude *.pyo
3
- recursive-exclude *.html
4
- include AUTHORS.rst
5
3
  include CHANGES.rst
6
4
  include CONTRIBUTING.rst
7
5
  include LICENSE
8
6
  include README.rst
9
7
  include examples.py
10
- include requirements.txt
11
- include Makefile
12
8
  include pytest.ini