Add easy import surface for std-compiling + SpecResults, and expose runtime __version__#13
Merged
Yong2Sheng merged 6 commits intodevelopfrom Feb 27, 2026
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
I improved ergonomics across the repo by defining a clearer “public” import surface and making version introspection available at runtime.
This PR includes:
SpecResultsinplot_spec_file.py__version__attribute backed by distribution metadataWhat changed
1) Easy imports for standard star compiling
__init__.py) so the most commonly used standard-star compiling entry points can be imported from a higher-level namespace.2) Easy imports for
SpecResultsSpecResultsinplot_spec_file.pyso I can import it without reaching into internal module paths.SpecResultsfeel like a first-class public API object.3) Runtime
__version__from packaging metadata__version__usingimportlib.metadata.version("researchcodes"), so the version comes from the installed distribution metadata rather than being duplicated in code.researchcodes.__version__at runtime.Why
__version__via metadata avoids maintaining duplicate version strings and aligns with modernpyproject.toml-based packaging.How to test