[Tiny Feature] Add mcrfpy.version for version identity #164

New issue

Closed

opened 2025-12-29 03:54:03 +00:00 by john · 0 comments

john commented

2025-12-29 03:54:03 +00:00

Owner

Summary

Users and bug reports need a way to identify which version of McRogueFace they're running.

Implementation

Add version string to the mcrfpy module:

>>> import mcrfpy
>>> mcrfpy.__version__
'1.0.0'

Details

Define version in one place (probably McRFPy_API.cpp or a header)
Expose as __version__ attribute on the module
Follow semantic versioning: MAJOR.MINOR.PATCH
Consider also exposing:
- mcrfpy.__sfml_version__ - underlying SFML version
- mcrfpy.__python_version__ - embedded Python version

Version Scheme

1.0.0 - First public release
1.0.x - Bug fixes
1.x.0 - New features, backward compatible
2.0.0 - Breaking API changes

README should display current version
Website should show version
Release tags should match version string

## Summary Users and bug reports need a way to identify which version of McRogueFace they're running. ## Implementation Add version string to the `mcrfpy` module: ```python >>> import mcrfpy >>> mcrfpy.__version__ '1.0.0' ``` ## Details 1. Define version in one place (probably `McRFPy_API.cpp` or a header) 2. Expose as `__version__` attribute on the module 3. Follow semantic versioning: `MAJOR.MINOR.PATCH` 4. Consider also exposing: - `mcrfpy.__sfml_version__` - underlying SFML version - `mcrfpy.__python_version__` - embedded Python version ## Version Scheme - **1.0.0** - First public release - **1.0.x** - Bug fixes - **1.x.0** - New features, backward compatible - **2.0.0** - Breaking API changes ## Related - README should display current version - Website should show version - Release tags should match version string