getcodelimit / codelimit

Your Refactoring Alarm 🔔
https://codelimit.vercel.app
GNU General Public License v3.0
36 stars 3 forks source link

Give cool project a cool command-line interface #11

Closed JnyJny closed 1 year ago

JnyJny commented 1 year ago

I've added a stanza in the pyproject.toml file that helps poetry create a stub executable so now we can do stuff like:

$ poetry shell
$ poetry install
...
$ codelimit

Additionally after publishing to PyPI, codelimit can be installed and used like:

$ python3 -m pip install codelimit
$ python3 -m codelimit --help
...
$ codelimit --help
...

I realize this is out of the blue, but Bob Belderbos turned me on to your tool this morning and I got excited about it.

JnyJny commented 1 year ago

FYI, I did not test the --upload functionality since I didn't know what the consequences of uploading to the URL would be.

robvanderleek commented 1 year ago

Hi @JnyJny 👋

Thanks a lot for your first contribution!

This project is still in its infancy 🐣 Please have patience while basic stuff is missing or broken. I really appreciate your contributions and any positive/negative feedback!

To briefly answer your questions: I'm setting up semantic versioning for deployments to PyPi. The --upload functionality is eventually needed to run this tool in a GH Actions flow.

KR, Rob

JnyJny commented 1 year ago

Thanks for accepting my PR!

I just realized I didn't provide an updated README.md to reflect the new usage and not sure if the Textual console development mode is broken now. But that's what future issue and PRs are for I guess!

robvanderleek commented 1 year ago

I've updated the README 👍 At this point of the project (pre-alpha) I'm committing smaller changes directly to main, let me know if that's inconvenient for you.

For pyinstaller I needed to change the relative imports back into regular imports. Not sure how I want to distribute this app (definitely through PyPi, but also as a single binary through homebrew). Very interested in your feedback on that topic.

Textual development mode is still broken, need to look into that.