docs: update Python and installation guidance#1851
Conversation
|
Hi @puneetdixit200 — and welcome, this is a really nice first contribution! 🙏 Thanks for taking the time to comb through the install docs. You spotted exactly the kind of rot that accumulates over a long-lived project: a One thing we need before merging: the AI assistance disclosure fileThank you for being upfront about the AI assistance — that's exactly the spirit of our policy. However, for the disclosure to count we need it as a separate, committed file in the The process is documented in For your PR, please add a file along these lines and commit it to your branch: Path: ## AI Assistance Disclosure
- [ ] I did **not** use any AI-assistance tools to help create this pull request.
- [x] I **did** use AI-assistance tools to *help* create this pull request.
- [x] I have read, understood and followed the projects' [AI Policy](https://github.com/crossbario/autobahn-python/blob/master/AI_POLICY.md) when creating code, documentation etc. for this pull request.
Submitted by: @puneetdixit200
Date: <UTC date this PR was opened, YYYY-MM-DD>
Related issue(s): #1826
Branch: puneetdixit200:docs/python-installation-guidanceA note in your direction: we have to apologise — we currently ship two PR templates and they say different things (one points to the Small notes on the content
The bigger pictureYou've put your finger on something we're very aware of. The Autobahn|Python docs as a whole have drifted and need a real overhaul — not just version bumps, but restructuring around current use cases (modern asyncio, type hints, the WAMP feature set as it stands today, etc.). That work is on the near-term roadmap, and contributions like this one are genuinely helpful both directly and as a signal that there's interest from the community in helping make it happen. If you'd like to be involved in the larger docs effort once it kicks off, please say so — we'd love the help. Thanks again, and welcome aboard! 🚀 |
|
oh, thanks a lot for fixing some unrelated/new CICD glitches on your way! |
|
fantastic, 100% green, thanks for contributing! |
Description
Summary: Update Python version and installation guidance for the current Autobahn release line.
Motivation: The docs still referenced older Python support and stale installation examples, while the current package metadata and PyPI release require Python 3.11+ and publish binary wheels for supported targets.
Related Issue(s): Fixes #1826
Type of Change
Changes Made
Core Changes
python -m pip install autobahnusage and current extras.API Changes
Documentation Changes
25.12.2release line.v0.9.1examples.Testing
Test Coverage
Testing Checklist
Test Results
Code Quality
Performance Impact
Benchmarks (if applicable):
Breaking Changes
Breaking Changes Description:
N/A
Migration Guide:
# N/A - documentation only.Deployment Notes
Deployment Steps (if applicable):
Screenshots/Recordings
N/A
Checklist
AI Assistance Disclosure
If AI-assisted, please provide details:
pyproject.toml, current PyPI release metadata, and the documentation checks listed above before submission.Note: Per AI_POLICY.md, you (the human) are the sole author of this contribution.
AI assistance is acknowledged but does not constitute co-authorship.
Additional Notes
The full Sphinx build is blocked in this local environment by the missing system
enchantC library required bysphinxcontrib.spelling. A Sphinx HTML build with only that spelling extension excluded completed successfully.