mixinforge 0.238.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 (188) hide show
  1. mixinforge-0.238.0/.claude/settings.local.json +18 -0
  2. mixinforge-0.238.0/.github/workflows/ruff.yml +27 -0
  3. mixinforge-0.238.0/.github/workflows/unit-tests.yml +34 -0
  4. mixinforge-0.238.0/.gitignore +158 -0
  5. mixinforge-0.238.0/.readthedocs.yaml +33 -0
  6. mixinforge-0.238.0/CONTRIBUTING.md +81 -0
  7. mixinforge-0.238.0/LICENSE +21 -0
  8. mixinforge-0.238.0/PKG-INFO +538 -0
  9. mixinforge-0.238.0/README.md +493 -0
  10. mixinforge-0.238.0/cache_cleanup_report.md +42 -0
  11. mixinforge-0.238.0/docs/Makefile +20 -0
  12. mixinforge-0.238.0/docs/make.bat +35 -0
  13. mixinforge-0.238.0/docs/requirements.txt +5 -0
  14. mixinforge-0.238.0/docs/source/api/mixinforge.rst +8 -0
  15. mixinforge-0.238.0/docs/source/api/modules.rst +45 -0
  16. mixinforge-0.238.0/docs/source/conf.py +90 -0
  17. mixinforge-0.238.0/docs/source/index.rst +678 -0
  18. mixinforge-0.238.0/docstrings_comments.md +721 -0
  19. mixinforge-0.238.0/htmlReport/.gitignore +2 -0
  20. mixinforge-0.238.0/htmlReport/class_index.html +1761 -0
  21. mixinforge-0.238.0/htmlReport/coverage_html_cb_dd2e7eb5.js +735 -0
  22. mixinforge-0.238.0/htmlReport/favicon_32_cb_c827f16f.png +0 -0
  23. mixinforge-0.238.0/htmlReport/function_index.html +5371 -0
  24. mixinforge-0.238.0/htmlReport/index.html +513 -0
  25. mixinforge-0.238.0/htmlReport/keybd_closed_cb_900cfef5.png +0 -0
  26. mixinforge-0.238.0/htmlReport/status.json +1 -0
  27. mixinforge-0.238.0/htmlReport/style_cb_9ff733b0.css +389 -0
  28. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f___init___py.html +109 -0
  29. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f_common_py.html +248 -0
  30. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f_diff_tools_py.html +191 -0
  31. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f_messages_py.html +318 -0
  32. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f_output_py.html +150 -0
  33. mixinforge-0.238.0/htmlReport/z_205d6ec405a1561f_pytest_plugin_py.html +563 -0
  34. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_access_jsparams_py.html +148 -0
  35. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_core_py.html +353 -0
  36. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_get_all_py.html +177 -0
  37. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_get_single_py.html +175 -0
  38. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_get_status_py.html +185 -0
  39. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_set_py.html +218 -0
  40. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_cacheable_properties_mixin_wrapping_py.html +174 -0
  41. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_dict_sorter_py.html +159 -0
  42. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_guarded_init_metaclass_helpers_py.html +257 -0
  43. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_guarded_init_metaclass_py.html +374 -0
  44. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_cover_slots_branch_py.html +150 -0
  45. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_extra_py.html +161 -0
  46. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_py.html +338 -0
  47. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_remaining_branches_py.html +172 -0
  48. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_round_trips_py.html +400 -0
  49. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_slots_paths_py.html +162 -0
  50. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_json_processor_slots_tuple_variants_py.html +141 -0
  51. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_not_picklable_py.html +124 -0
  52. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_parameterizable_essential_auxiliary_py.html +152 -0
  53. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_parameterizable_py.html +176 -0
  54. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_single_thread_enforcer_py.html +207 -0
  55. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_update_jsparams_plain_dict_py.html +108 -0
  56. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_update_jsparams_py.html +151 -0
  57. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_version_fallback_py.html +125 -0
  58. mixinforge-0.238.0/htmlReport/z_22e0b146183f77d0_test_version_py.html +172 -0
  59. mixinforge-0.238.0/htmlReport/z_82d839cb922eb8b7__jb_pytest_runner_py.html +183 -0
  60. mixinforge-0.238.0/htmlReport/z_82d839cb922eb8b7__jb_runner_tools_py.html +532 -0
  61. mixinforge-0.238.0/htmlReport/z_82d839cb922eb8b7__jb_serial_tree_manager_py.html +210 -0
  62. mixinforge-0.238.0/htmlReport/z_82d839cb922eb8b7__jb_utils_py.html +268 -0
  63. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48___init___py.html +144 -0
  64. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48__version_info_py.html +105 -0
  65. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_cacheable_properties_mixin_py.html +326 -0
  66. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_dict_sorter_py.html +123 -0
  67. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_guarded_init_metaclass_py.html +364 -0
  68. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_json_processor_py.html +572 -0
  69. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_not_picklable_mixin_py.html +147 -0
  70. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_parameterizable_mixin_py.html +259 -0
  71. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_single_thread_enforcer_mixin_py.html +198 -0
  72. mixinforge-0.238.0/htmlReport/z_86fcc6303e509e48_singleton_mixin_py.html +132 -0
  73. mixinforge-0.238.0/project_metrics.md +9 -0
  74. mixinforge-0.238.0/pyproject.toml +95 -0
  75. mixinforge-0.238.0/readthedocs.md +343 -0
  76. mixinforge-0.238.0/src/mixinforge/__init__.py +91 -0
  77. mixinforge-0.238.0/src/mixinforge/_version_info.py +8 -0
  78. mixinforge-0.238.0/src/mixinforge/command_line_tools/__init__.py +2 -0
  79. mixinforge-0.238.0/src/mixinforge/command_line_tools/_cli_entry_points.py +487 -0
  80. mixinforge-0.238.0/src/mixinforge/command_line_tools/basic_file_utils.py +348 -0
  81. mixinforge-0.238.0/src/mixinforge/command_line_tools/project_analyzer.py +488 -0
  82. mixinforge-0.238.0/src/mixinforge/context_managers/__init__.py +2 -0
  83. mixinforge-0.238.0/src/mixinforge/context_managers/output_capturer.py +178 -0
  84. mixinforge-0.238.0/src/mixinforge/context_managers/output_suppressor.py +49 -0
  85. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/__init__.py +8 -0
  86. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/cacheable_properties_mixin.py +229 -0
  87. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/guarded_init_metaclass.py +336 -0
  88. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/immutable_mixin.py +154 -0
  89. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/immutable_parameterizable_mixin.py +64 -0
  90. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/not_picklable_mixin.py +64 -0
  91. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/parameterizable_mixin.py +171 -0
  92. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/single_thread_enforcer_mixin.py +102 -0
  93. mixinforge-0.238.0/src/mixinforge/mixins_and_metaclasses/singleton_mixin.py +42 -0
  94. mixinforge-0.238.0/src/mixinforge/py.typed +0 -0
  95. mixinforge-0.238.0/src/mixinforge/utility_functions/__init__.py +19 -0
  96. mixinforge-0.238.0/src/mixinforge/utility_functions/atomics_detector.py +356 -0
  97. mixinforge-0.238.0/src/mixinforge/utility_functions/dict_sorter.py +24 -0
  98. mixinforge-0.238.0/src/mixinforge/utility_functions/json_processor.py +460 -0
  99. mixinforge-0.238.0/src/mixinforge/utility_functions/nested_collections_inspector.py +321 -0
  100. mixinforge-0.238.0/src/mixinforge/utility_functions/nested_collections_transformer.py +352 -0
  101. mixinforge-0.238.0/src/mixinforge/utility_functions/notebook_checker.py +37 -0
  102. mixinforge-0.238.0/src/mixinforge/utility_functions/package_manager.py +475 -0
  103. mixinforge-0.238.0/tests/__init__.py +0 -0
  104. mixinforge-0.238.0/tests/__live_actions__/__init__.py +50 -0
  105. mixinforge-0.238.0/tests/__live_actions__/clean_dist_live_action.py +60 -0
  106. mixinforge-0.238.0/tests/__live_actions__/clear_cache_live_action.py +104 -0
  107. mixinforge-0.238.0/tests/__live_actions__/refresh_venv_live_action.py +72 -0
  108. mixinforge-0.238.0/tests/__live_actions__/update_stats_live_action.py +149 -0
  109. mixinforge-0.238.0/tests/command_line_tools/__init__.py +0 -0
  110. mixinforge-0.238.0/tests/command_line_tools/cli/__init__.py +0 -0
  111. mixinforge-0.238.0/tests/command_line_tools/cli/conftest.py +153 -0
  112. mixinforge-0.238.0/tests/command_line_tools/cli/test_cli_argument_parsing.py +168 -0
  113. mixinforge-0.238.0/tests/command_line_tools/cli/test_mf_clear_cache_command.py +111 -0
  114. mixinforge-0.238.0/tests/command_line_tools/cli/test_mf_get_stats_command.py +80 -0
  115. mixinforge-0.238.0/tests/command_line_tools/cli/test_readme_marker_updates.py +177 -0
  116. mixinforge-0.238.0/tests/command_line_tools/cli/test_rst_marker_updates.py +199 -0
  117. mixinforge-0.238.0/tests/command_line_tools/test_basic_file_utils.py +430 -0
  118. mixinforge-0.238.0/tests/command_line_tools/test_basic_file_utils_categorization.py +155 -0
  119. mixinforge-0.238.0/tests/command_line_tools/test_basic_file_utils_dist.py +167 -0
  120. mixinforge-0.238.0/tests/command_line_tools/test_basic_file_utils_edge_cases.py +100 -0
  121. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_data_classes.py +282 -0
  122. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_error_handling.py +159 -0
  123. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_file_analysis.py +509 -0
  124. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_path_validation.py +127 -0
  125. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_project_analysis.py +272 -0
  126. mixinforge-0.238.0/tests/command_line_tools/test_project_analyzer_verbose_mode.py +133 -0
  127. mixinforge-0.238.0/tests/context_managers/__init__.py +0 -0
  128. mixinforge-0.238.0/tests/context_managers/test_output_capturer.py +274 -0
  129. mixinforge-0.238.0/tests/context_managers/test_output_suppressor.py +34 -0
  130. mixinforge-0.238.0/tests/demo_types.py +41 -0
  131. mixinforge-0.238.0/tests/mixins_and_metaclasses/__init__.py +0 -0
  132. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/__init__.py +0 -0
  133. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_core.py +256 -0
  134. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_get_all.py +80 -0
  135. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_get_single.py +78 -0
  136. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_get_status.py +88 -0
  137. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_set.py +121 -0
  138. mixinforge-0.238.0/tests/mixins_and_metaclasses/cacheable_properties/test_cacheable_properties_mixin_wrapping.py +77 -0
  139. mixinforge-0.238.0/tests/mixins_and_metaclasses/integration/__init__.py +5 -0
  140. mixinforge-0.238.0/tests/mixins_and_metaclasses/integration/test_mixin_composition.py +353 -0
  141. mixinforge-0.238.0/tests/mixins_and_metaclasses/metaclass/__init__.py +0 -0
  142. mixinforge-0.238.0/tests/mixins_and_metaclasses/metaclass/test_guarded_init_metaclass.py +369 -0
  143. mixinforge-0.238.0/tests/mixins_and_metaclasses/metaclass/test_guarded_init_metaclass_helpers.py +160 -0
  144. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/__init__.py +0 -0
  145. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_immutable_mixin.py +216 -0
  146. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_immutable_mixin_pickling.py +161 -0
  147. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_immutable_parameterizable_mixin.py +97 -0
  148. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_single_thread_enforcer.py +202 -0
  149. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_singleton_mixin.py +167 -0
  150. mixinforge-0.238.0/tests/mixins_and_metaclasses/mixins/test_singleton_mixin_pickling.py +102 -0
  151. mixinforge-0.238.0/tests/mixins_and_metaclasses/parameterizable/__init__.py +0 -0
  152. mixinforge-0.238.0/tests/mixins_and_metaclasses/parameterizable/test_extract_params_dict.py +73 -0
  153. mixinforge-0.238.0/tests/mixins_and_metaclasses/parameterizable/test_not_picklable.py +27 -0
  154. mixinforge-0.238.0/tests/mixins_and_metaclasses/parameterizable/test_parameterizable.py +93 -0
  155. mixinforge-0.238.0/tests/mixins_and_metaclasses/parameterizable/test_parameterizable_essential_auxiliary.py +55 -0
  156. mixinforge-0.238.0/tests/utility_functions/__init__.py +0 -0
  157. mixinforge-0.238.0/tests/utility_functions/json_processor/__init__.py +0 -0
  158. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor.py +241 -0
  159. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_cover_slots_branch.py +53 -0
  160. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_extra.py +62 -0
  161. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_remaining_branches.py +75 -0
  162. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_round_trips.py +323 -0
  163. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_slots_paths.py +65 -0
  164. mixinforge-0.238.0/tests/utility_functions/json_processor/test_json_processor_slots_tuple_variants.py +43 -0
  165. mixinforge-0.238.0/tests/utility_functions/jsparams/__init__.py +0 -0
  166. mixinforge-0.238.0/tests/utility_functions/jsparams/test_access_jsparams.py +80 -0
  167. mixinforge-0.238.0/tests/utility_functions/jsparams/test_update_jsparams.py +82 -0
  168. mixinforge-0.238.0/tests/utility_functions/jsparams/test_update_jsparams_plain_dict.py +10 -0
  169. mixinforge-0.238.0/tests/utility_functions/test_atomics_detector.py +472 -0
  170. mixinforge-0.238.0/tests/utility_functions/test_dict_sorter.py +62 -0
  171. mixinforge-0.238.0/tests/utility_functions/test_find_atomics.py +478 -0
  172. mixinforge-0.238.0/tests/utility_functions/test_find_nonatomics.py +180 -0
  173. mixinforge-0.238.0/tests/utility_functions/test_notebook_checker.py +157 -0
  174. mixinforge-0.238.0/tests/utility_functions/test_package_manager.py +550 -0
  175. mixinforge-0.238.0/tests/utility_functions/test_package_manager_uninstall_verification.py +210 -0
  176. mixinforge-0.238.0/tests/utility_functions/test_transform_instances.py +753 -0
  177. mixinforge-0.238.0/tests/utility_functions/test_transform_instances_coverage.py +441 -0
  178. mixinforge-0.238.0/tests/utility_functions/test_transform_instances_dedup.py +257 -0
  179. mixinforge-0.238.0/tests/utility_functions/test_transform_instances_defaultdict.py +59 -0
  180. mixinforge-0.238.0/tests/utility_functions/test_transform_instances_edge_cases.py +151 -0
  181. mixinforge-0.238.0/tests/utility_functions/test_transform_instances_extra.py +119 -0
  182. mixinforge-0.238.0/tests/utility_functions/test_traversal_logic.py +260 -0
  183. mixinforge-0.238.0/tests/utility_functions/test_traversal_performance.py +47 -0
  184. mixinforge-0.238.0/tests/version/__init__.py +0 -0
  185. mixinforge-0.238.0/tests/version/test_version.py +75 -0
  186. mixinforge-0.238.0/tests/version/test_version_fallback.py +26 -0
  187. mixinforge-0.238.0/type_hints.md +111 -0
  188. mixinforge-0.238.0/unit_tests.md +339 -0
@@ -0,0 +1,18 @@
1
+ {
2
+ "permissions": {
3
+ "allow": [
4
+ "Bash(wc:*)",
5
+ "Bash(python -m pytest --collect-only -q)",
6
+ "Bash(/usr/bin/python3 -m pytest:*)",
7
+ "Bash(find:*)",
8
+ "Bash(grep:*)",
9
+ "Bash(python3:*)",
10
+ "Bash(.venv/bin/python -m pytest:*)",
11
+ "Bash(python -m pytest:*)",
12
+ "Bash(pytest:*)",
13
+ "Bash(uv run pytest:*)",
14
+ "Bash(uv build:*)",
15
+ "Bash(tree:*)"
16
+ ]
17
+ }
18
+ }
@@ -0,0 +1,27 @@
1
+ name: Ruff
2
+
3
+ on:
4
+ push:
5
+ branches: [master]
6
+ pull_request:
7
+ workflow_dispatch:
8
+
9
+ permissions:
10
+ contents: read
11
+
12
+ jobs:
13
+ lint:
14
+ name: ruff check
15
+ runs-on: ubuntu-latest
16
+ steps:
17
+ - name: Checkout repository
18
+ uses: actions/checkout@v4
19
+
20
+ - name: Install uv
21
+ uses: astral-sh/setup-uv@v3
22
+
23
+ - name: Install Ruff
24
+ run: uv tool install ruff
25
+
26
+ - name: Run Ruff
27
+ run: ruff check .
@@ -0,0 +1,34 @@
1
+ name: Run Pytest
2
+
3
+ on:
4
+ push:
5
+ branches: [ master ]
6
+ pull_request:
7
+ branches: [ master ]
8
+
9
+ jobs:
10
+ build:
11
+
12
+ strategy:
13
+ matrix:
14
+ os: [ ubuntu-latest, windows-latest, macos-latest ]
15
+ python-version: [ "3.11", "3.12", "3.13", "3.14" ]
16
+
17
+ runs-on: ${{ matrix.os }}
18
+
19
+ steps:
20
+ - uses: actions/checkout@v4
21
+
22
+ - name: Set up Python ${{ matrix.python-version }} and uv
23
+ uses: actions/setup-python@v5
24
+ with:
25
+ python-version: ${{ matrix.python-version }}
26
+
27
+ - name: Install uv
28
+ run: pip install uv
29
+
30
+ - name: Install dependencies
31
+ run: uv pip install -e ".[dev]" --system
32
+
33
+ - name: Test with pytest
34
+ run: pytest
@@ -0,0 +1,158 @@
1
+
2
+ # Byte-compiled / optimized / DLL files
3
+ __pycache__/
4
+ *.py[cod]
5
+ *$py.class
6
+
7
+ # C extensions
8
+ *.so
9
+
10
+ # Distribution / packaging
11
+ .Python
12
+ build/
13
+ develop-eggs/
14
+ dist/
15
+ downloads/
16
+ eggs/
17
+ .eggs/
18
+ lib/
19
+ lib64/
20
+ parts/
21
+ sdist/
22
+ var/
23
+ wheels/
24
+ share/python-wheels/
25
+ *.egg-info/
26
+ .installed.cfg
27
+ *.egg
28
+ MANIFEST
29
+
30
+ # PyInstaller
31
+ # Usually these files are written by a python script from a template
32
+ # before PyInstaller builds the exe, so as to inject date/other infos into it.
33
+ *.manifest
34
+ *.spec
35
+
36
+ # Installer logs
37
+ pip-log.txt
38
+ pip-delete-this-directory.txt
39
+
40
+ # Unit test / coverage reports
41
+ htmlcov/
42
+ .tox/
43
+ .nox/
44
+ .coverage
45
+ .coverage.*
46
+ .cache
47
+ nosetests.xml
48
+ coverage.xml
49
+ *.cover
50
+ *.py,cover
51
+ .hypothesis/
52
+ .pytest_cache/
53
+ cover/
54
+
55
+ # Translations
56
+ *.mo
57
+ *.pot
58
+
59
+ # Django stuff:
60
+ *.log
61
+ local_settings.py
62
+ db.sqlite3
63
+ db.sqlite3-journal
64
+
65
+ # Flask stuff:
66
+ instance/
67
+ .webassets-cache
68
+
69
+ # Scrapy stuff:
70
+ .scrapy
71
+
72
+ # Sphinx documentation
73
+ docs/_build/
74
+
75
+ # PyBuilder
76
+ .pybuilder/
77
+ target/
78
+
79
+ # Jupyter Notebook
80
+ .ipynb_checkpoints
81
+
82
+ # IPython
83
+ profile_default/
84
+ ipython_config.py
85
+
86
+ # pyenv
87
+ # For a library or package, you might want to ignore these files since the code is
88
+ # intended to run in multiple environments; otherwise, check them in:
89
+ # .python-version
90
+
91
+ # pipenv
92
+ # According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
93
+ # However, in case of collaboration, if having platform-specific dependencies or dependencies
94
+ # having no cross-platform support, pipenv may install dependencies that don't work, or not
95
+ # install all needed dependencies.
96
+ #Pipfile.lock
97
+
98
+ # poetry
99
+ # Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
100
+ # This is especially recommended for binary packages to ensure reproducibility, and is more
101
+ # commonly ignored for libraries.
102
+ # https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
103
+ #poetry.lock
104
+
105
+ # uv
106
+ uv.lock
107
+
108
+ # PEP 582; used by e.g. github.com/David-OConnor/pyflow
109
+ __pypackages__/
110
+
111
+
112
+ # Celery stuff
113
+ celerybeat-schedule
114
+ celerybeat.pid
115
+
116
+ # SageMath parsed files
117
+ *.sage.py
118
+
119
+ # Environments
120
+ .env
121
+ .venv
122
+ env/
123
+ venv/
124
+ ENV/
125
+ env.bak/
126
+ venv.bak/
127
+
128
+ # Spyder project settings
129
+ .spyderproject
130
+ .spyproject
131
+
132
+ # Rope project settings
133
+ .ropeproject
134
+
135
+ # mkdocs documentation
136
+ /site
137
+
138
+ # mypy
139
+ .mypy_cache/
140
+ .dmypy.json
141
+ dmypy.json
142
+
143
+ # Pyre type checker
144
+ .pyre/
145
+
146
+ # pytype static type analyzer
147
+ .pytype/
148
+
149
+ # Cython debug symbols
150
+ cython_debug/
151
+
152
+ # PyCharm
153
+ # JetBrains specific template is maintained in a separate JetBrains.gitignore that can
154
+ # be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
155
+ # and can be added to the global gitignore or merged into this file. For a more nuclear
156
+ # option (not recommended) you can uncomment the following to ignore the entire idea folder.
157
+ .idea/
158
+ .DS_Store
@@ -0,0 +1,33 @@
1
+ # .readthedocs.yaml
2
+ # Read the Docs configuration file
3
+ # See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
4
+
5
+ version: 2
6
+
7
+ # Set the version of Python and other tools you might need
8
+ build:
9
+ os: ubuntu-22.04
10
+ tools:
11
+ python: "3.11"
12
+ jobs:
13
+ post_install:
14
+ - pip install -e .
15
+
16
+ # Build documentation in the docs/ directory with Sphinx
17
+ sphinx:
18
+ configuration: docs/source/conf.py
19
+ fail_on_warning: false
20
+
21
+ # Specify the Python requirements required to build your documentation.
22
+ python:
23
+ install:
24
+ - requirements: docs/requirements.txt
25
+ - method: pip
26
+ path: .
27
+ extra_requirements:
28
+ - docs
29
+
30
+ # Output formats
31
+ formats:
32
+ - pdf
33
+ - epub
@@ -0,0 +1,81 @@
1
+ # Contributing to mixinforge
2
+
3
+ Thank you for your interest in contributing to `mixinforge`!
4
+ Your help is greatly appreciated. These guidelines will help you get started.
5
+
6
+ ## Getting Started
7
+
8
+ 1. **Fork and Clone:**
9
+ ```bash
10
+ git clone https://github.com/your-username/mixinforge.git
11
+ cd mixinforge
12
+ ```
13
+
14
+ 2. **Install Dependencies:**
15
+ We use `uv` for package management.
16
+ ```bash
17
+ uv pip install -e ".[dev]"
18
+ ```
19
+
20
+ 3. **Run Tests:**
21
+ Make sure the test suite passes before making changes.
22
+ ```bash
23
+ pytest
24
+ ```
25
+
26
+ 4. **Run Linting:**
27
+ Make sure the code is free of linting errors.
28
+ ```bash
29
+ uv run ruff check .
30
+ ```
31
+
32
+ ## How to Contribute
33
+
34
+ * **Report Bugs:** Use the GitHub issue tracker to report bugs.
35
+ Please provide a clear description, steps to reproduce, and your Python version.
36
+ * **Suggest Enhancements:** Open an issue to discuss new features or improvements.
37
+
38
+ ### Submitting Pull Requests
39
+
40
+ 1. **Create a Branch:**
41
+ ```bash
42
+ git checkout -b your-feature-name
43
+ ```
44
+ 2. **Make Changes:** Write your code and add corresponding tests in the `tests/` directory.
45
+ 3. **Follow Code Style:**
46
+ * Adhere to PEP 8 guidelines.
47
+ * Write clear, Google-style docstrings for public functions and classes. See [docstrings_comments.md](https://github.com/pythagoras-dev/mixinforge/blob/master/docstrings_comments.md) for detailed guidelines.
48
+ * Add type hints where appropriate. See [type_hints.md](https://github.com/pythagoras-dev/mixinforge/blob/master/type_hints.md) for detailed guidelines.
49
+ * For documentation build configuration, see [readthedocs.md](https://github.com/pythagoras-dev/mixinforge/blob/master/readthedocs.md).
50
+ 4. **Check Tests:** Make sure the test suite passes.
51
+ 5. **Check Linting:** Make sure the code is free of linting errors.
52
+ 6. **Write Commit Messages:** Follow the conventions below.
53
+ 7. **Push and Open a Pull Request:** Push your branch to your fork and open a pull request.
54
+
55
+ ### Commit Message Prefixes
56
+
57
+ Use these prefixes for your commit messages:
58
+
59
+ | Prefix | Description |
60
+ |:--------|:-----------------------------------|
61
+ | `ENH:` | Enhancement, new functionality |
62
+ | `BUG:` | Bug fix |
63
+ | `DOC:` | Additions/updates to documentation |
64
+ | `TST:` | Additions/updates to tests |
65
+ | `BLD:` | Build process/script updates |
66
+ | `PERF:` | Performance improvement |
67
+ | `REF:` | Refactoring |
68
+ | `TYP:` | Type annotations |
69
+ | `CLN:` | Code cleanup |
70
+
71
+ *Example: `ENH: Add support for nested parameter validation`*
72
+
73
+ ## License
74
+
75
+ By contributing, you confirm that your contributions are an original work,
76
+ or you have permission to use it, and agree that it will be
77
+ licensed under the MIT License.
78
+
79
+ ## Questions?
80
+
81
+ Feel free to open an issue or contact the maintainer, Vlad (Volodymyr) Pavlov.
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2024-2026 Vlad (Volodymyr) Pavlov.
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.