docs: page about python versions

Klipper3d · Dec 31, 2024 · 8aa3931 · 8aa3931
1 parent 9bd0d47
commit 8aa3931
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/docs/Python_Versions.md b/docs/Python_Versions.md
@@ -0,0 +1,19 @@
+# Python Versions
+
+## Current Support
+Klippy (Klipper's python component) supports python 2.7, and python 3.5 and later,
+however user-installed host modules (AKA extras) may require higher versions.
+
+The tools in `scripts/`, vary, but all work on 3.6+.
+
+## Future Support
+The project has no plans to sunset support for Python 2 at this time.
+New versions of Python 3 may not be compatible immediately after release.
+
+## Development Notes
+* `ConfigParser` and `Queue` are handled by top-scope tweaks in `utils.py`.
+* CI Tests run with 2.7 and 3.8
+* Klippy's codebase only requires py 3.3, but dependances raise it to 3.5
+
+## References
+* [Discourse topic on python versions](https://klipper.discourse.group/t/discuss-python-versions/20942)
diff --git a/docs/_klipper3d/mkdocs.yml b/docs/_klipper3d/mkdocs.yml
@@ -129,6 +129,7 @@ nav:
     - Benchmarks.md
     - CONTRIBUTING.md
     - Packaging.md
+    - Python_Versions.md
   - Device Specific Documents:
     - Example_Configs.md
     - SDCard_Updates.md