lincc-frameworks / lincc-frameworks/hyrax
Make it possible to run hyrax package as a script, aka `python -m hyrax`
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 41
- Forks
- 7
- Avg merge
- 5d 1h
- Merged PRs (30d)
- 8
Description
**Feature request**
Python environments are complicated and error-prone, so it is nice to have the opportunity to run Python scripts with `python -m module_name` instead of `script_name`. You can do it with a lot of common Python packages, e.g. `python -m http.server`, `python -m pip`, `python -m venv`, `python -m cmake`, etc. It would be nice to have `python -m hyrax` too!
This may be done by introducing a `__main__.py` file in the root of the hyrax package.
**Before submitting**
Please check the following:
- [x] I have described the purpose of the suggested change, specifying what I need the enhancement to accomplish, i.e. what problem it solves.
- [ ] I have included any relevant links, screenshots, environment information, and data relevant to implementing the requested feature, as well as pseudocode for how I want to access the new functionality.
- [x] If I have ideas for how the new feature could be implemented, I have provided explanations and/or pseudocode and/or task lists for the steps.
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by inspecting the root of the hyrax package and the proposed __main__.py entry point. Run `python -m hyrax` after the change and confirm that it invokes the package successfully, matching the requested script behavior.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- cli
- Issue type
- Feature
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 52/100