Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Missing click dependency and confusing methods interface #58

Open
daffidwilde opened this issue Dec 9, 2022 · 0 comments
Open

Missing click dependency and confusing methods interface #58

daffidwilde opened this issue Dec 9, 2022 · 0 comments

Comments

@daffidwilde
Copy link
Collaborator

Just running through a little audit on the documentation (as per @callummole's email to me some time ago now) and was stopped in my tracks straight away.

Using a clean installation of reprosyn in a conda environment, I tried to import a method and got a ModuleNotFoundError for click. It should be a simple enough fix but I don't use the CLI so defer to someone else to determine the required minimum version.

As another quick improvement, we should define an __all__ in methods/__init__.py to make it clearer which classes are usable when tab-completing (plus the COMMANDS tuple, which is used elsewhere). At the moment, you have to sift through a number of CLI commands and modules, which can be confusing. It might also be worth considering the way methods are named - using all caps is not the convention for class names unless they are acronyms.

Happy to help in implementing any of these things.

@daffidwilde daffidwilde changed the title Add click as dependency and clean up methods interface Missing click dependency and confusing methods interface Dec 9, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant