Add enterprise-grade documentation, packaging, CI, and runnable examples#2
Conversation
…ckage init Co-authored-by: MASSIVEMAGNETICS <209589629+MASSIVEMAGNETICS@users.noreply.github.com>
There was a problem hiding this comment.
💡 Codex Review
Here are some automated review suggestions for this pull request.
Reviewed commit: 4a891e4b34
ℹ️ About Codex in GitHub
Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you
- Open a pull request for review
- Mark a draft as ready
- Comment "@codex review".
If Codex has suggestions, it will comment; otherwise it will react with 👍.
Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".
| [tool.setuptools.packages.find] | ||
| where = ["."] | ||
| include = ["*"] | ||
| exclude = ["tests*", "benchmarks*", "examples*", "docs*"] |
There was a problem hiding this comment.
Include actual Python modules in distribution
Configure packaging to include the repository’s top-level modules, because this packages.find setup discovers no importable package in the current layout (all runtime code is in root-level .py files like lightweight_gravitational_transformer.py, training.py, etc.). As a result, built wheels contain only .dist-info metadata and users installing the project cannot import the library.
Useful? React with 👍 / 👎.
| "Documentation" = "https://github.com/MASSIVEMAGNETICS/Lightweight-Gravitational-Transformer/tree/main/docs" | ||
|
|
||
| [project.scripts] | ||
| lgt-export = "export_edge_model:main" |
There was a problem hiding this comment.
Point console script at an existing callable
The console entry point targets export_edge_model:main, but export_edge_model.py does not define a main function (it only has an if __name__ == "__main__" block). Packaging tools will still generate lgt-export, but invoking it will fail at runtime when it cannot resolve the callable.
Useful? React with 👍 / 👎.
The repo had a single-line README and no packaging, CI, or usage examples — making it hard to onboard users or contribute.
Documentation
Packaging & Infrastructure
dev/benchmarksextras,lgt-exportCLI entry point, pytest + coverage config__init__.py—__version__ = "0.1.0", clean__all__re-exporting the full public APIcontents: readpermissionsExamples (
examples/)Five self-contained runnable scripts:
No source logic was changed; all 66 existing tests continue to pass.
💡 You can make Copilot smarter by setting up custom instructions, customizing its development environment and configuring Model Context Protocol (MCP) servers. Learn more Copilot coding agent tips in the docs.