search

remimorvan / knowledge-clustering

Clustering notions for the knowledge LaTeX package
MIT License
13 stars 1 forks source link

Setup.py + CLI improvements #1

Closed AliaumeL closed 2 years ago

AliaumeL commented 2 years ago

This PR contains several key changes

  1. Instead of a module we use a python package
  2. We correctly refer to the package location using pkg_resources
  3. Added keywords to the setup.py
  4. Added instructions for local development using virtualenv
  5. Using Click instead of argparse
  6. Better handling of files (check if they exist, ask before replacing, etc.)

As this PR mostly moves files around and does not remove « old code » from the knowledge.py file I believe it should be accepted as-is, with the promise of getting rid of legacy code in the future.

remimorvan commented 2 years ago

@AliaumeL Is there a reason why you're using setup.py instead of setup.cfg? Using the latter is recommended by https://packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata

AliaumeL commented 2 years ago

@AliaumeL Is there a reason why you're using setup.py instead of setup.cfg? Using the latter is recommended by https://packaging.python.org/en/latest/tutorials/packaging-projects/#configuring-metadata

You are right, it was because I am used to setup.py and it has syntax highlighting/linting/completion in my editor. As it contains roughly the same options and should not be modified so often I am not against the setup.cfg file.