search

diafygi / acme-tiny

A tiny script to issue and renew TLS certs from Let's Encrypt
MIT License
4.74k stars 572 forks source link

Rename the script to "acme-tiny" #96

Closed tasn closed 8 years ago

tasn commented 8 years ago

Hey,

In Linux, scripts in path usually do not include a file extension and more commonly use dashes rather than underscores. Instead of making distributions rename the script (or worse, keep it as it is), it's better if the script is renamed from "acme_tiny.py" to "acme-tiny".

Thanks, Tom.

rspeed commented 8 years ago

43 will add the script to to $PATH as acme-tiny, so this is essentially a duplicate.

tasn commented 8 years ago

That's good to hear, but wouldn't it be a good idea to also name it in the repository?

rspeed commented 8 years ago

It would be unnecessary. The recommended installation procedure would change to installing through pip rather than cloning from Github.

tasn commented 8 years ago

Just for consistency between the system and the git repo. Not a big deal here as there is literally only one script.

I guess that if people still disagree this can be closed.

rspeed commented 8 years ago

I'm not trying to be discouraging, and I totally agree with the suggestion. But this type of configuration is the standard way to distribute executable python scripts via PyPI.

tasn commented 8 years ago

I'm not discouraged. I don't know the PyPI world well enough to comment about common practices. To me it looks odd to have a script named differently in the source repository compared to the installed version. However if it's standard practice, I guess it's fine. It's still awful, but at least awfully consistent.

Bottom line: I appreciate your (quick!) feedback, if it's standard practice, it doesn't need to change.

rspeed commented 8 years ago

Under normal conditions nobody would actually see that difference.

tasn commented 8 years ago

I disagree, a random contributor (new to the project) will come looking for "acme-tiny" only to find acme_tiny.py. It's just that much more annoying. Again, not the end of the world, but why not make it better?

rspeed commented 8 years ago

I would hope a potential contributor would be accustomed to this type of setup. But regardless, that change would make it much more difficult to import acme-tiny as a python module, which in turn would make it more difficult to do things like running unit tests.

tasn commented 8 years ago

That is a good enough reason to kill this idea altogether. Sorry for wasting your (and my) time.

Thanks for your feedback.

rspeed commented 8 years ago

Not wasted in the least!