Release Summary
This release marks the transition from 3.2.3 to 4.0.4 and focuses on making the project easier to consume as both a web API and a Python package.
- OpenMLBB SDK documentation is now available directly in the web interface.
- Navigation and landing page messaging were improved for Python users.
- Release flow remains automated while version control is now manual from config.
OpenMLBB Documentation Expansion
The OpenMLBB documentation was expanded from a single endpoint page to structured coverage for all SDK groups.
- Academy, MLBB, User, and Addon clients are documented with endpoint-level examples.
- Endpoint cards now include concise Python examples and request requirement tables.
- Open-only endpoint navigation and sidebar grouping improve discoverability.
User Experience Improvements
This release improves clarity for onboarding users who start from the website home page.
- Landing page now prominently highlights the install command: pip install OpenMLBB.
- OpenMLBB endpoint descriptions now use a proper collapsed/expanded behavior for long text.
- Navbar paths are aligned with the latest OpenMLBB documentation flow.
Versioning and Publishing Flow
The release process is now explicitly tied to manually managed project version configuration.
- Version source for release and PyPI publish is PROJECT_VERSION in app/core/config.py.
- GitHub release creation and PyPI publishing stay automated in workflow execution.
- Tag naming remains in 4.x.x format without a v prefix.
Migration Notes
Existing API consumers can keep current integrations while adopting the SDK and docs improvements gradually.
- If you publish a new release, update PROJECT_VERSION in config first.
- Use the /openmlbb docs route for endpoint-by-endpoint SDK mapping.
- Validate client examples against the updated docs for best onboarding experience.