Submit to Awesome List

[pykong]

This package fills a unique void, left by other packages. Namely it does two things:

• many string conversions
• acronym detection

Hence it would be useful to make it known to the python community. The best way would be an entry to the awesome list at: https://github.com/vinta/awesome-python

This may be done, once more cases have been added and the internal structure has undergone further refactoring. The extensive tests provided speak for the quality of this package and may improve its acceptance.

TODO before ready for submission:

• [x] add more case conversions
• [ ] make it easier to contribute
  • [x] Add ~~requirements.txt~~ pyproject.toml
  • [x] Add ~~MakeFile with make test and make lint options~~ pyproject.toml
  • [ ] Add Contribute section to README
  • [x] Add CI
• [ ] Clean up code for readability
  • [ ] rename 1-character variables (where it makes sense)
  • [ ] review sections of the code that require line comments to explain them. That usually indicates that it can be rewritten more clearly
• [ ] Modification of API to conform to #7
• [x] Add type annotations
• [x] Adapt tests to new API and added case conversions

[AlejandroFrias]

Great suggestion. I agree there is to do before it's ready for that. Let's use this ticket as a TODO list of things before it's ready for submission.

[pykong]

I have added type annotations to allow static type checking via MyPy. New API and extended test cases.

I agree that single char vars are a bad practice, when they are not short lived. We should find better names for those. (And other variables as well as I have already started to do.)

[AlejandroFrias]

I added you as a collaborator. You just need to accept and then I can give you full access. I haven't published to PyPi in so long that I forget how to do that and what do in order to allow you to push to PyPi yourself in my stead.

[pykong]

Thank you!

The coupling with PyPI is indeed an important question. Admittedly, I have no experience with contributing to PyPI at this point.

A quick search yielded this gist by a respectable python author: https://gist.github.com/audreyr/5990987

Most importantly the described process does not suggest PyPI automatically fetches the latest commit from the github repo, as such (unlikely) behaviour would suggest the danger of an accidental release.

[pykong]

@AlejandroFrias I will be occupied with other things til early May. This is still on my radar. (Especially since I need this library for another Sublime Text plugin I am coding. Kind of the last missing piece in this regard.)