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

New CLI / Config #310

Merged
merged 31 commits into from
Aug 11, 2020
Merged

New CLI / Config #310

merged 31 commits into from
Aug 11, 2020

Conversation

36000
Copy link
Collaborator

@36000 36000 commented Jul 22, 2020

The AFQ.api.AFQ.init docstring is now scraped to make a configuration file with all of the defaults and descriptions.
The scraping is done with: https://github.com/Chilipp/funcargparse

usage.rst can also be generated using updatedocs.py . If there were some way to call this automatically on server side for each commit, that could be cool.

@pep8speaks
Copy link

pep8speaks commented Jul 22, 2020

Hello @36000! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2020-08-11 19:53:27 UTC

@36000 36000 mentioned this pull request Jul 22, 2020
@36000
Copy link
Collaborator Author

36000 commented Jul 22, 2020

Looks like Cli2Gui, which primarily uses pysimplegui, is getting pyqt installed, not because pysimplegui requires it but because getostheme requires it.

Other than Cli2Gui, there is also Gooey, but that requires wxpython.

It may be simplest to just use pysimplegui directly.

@arokem arokem added this to the Version 0.4 milestone Jul 24, 2020
@36000 36000 changed the title New CLI / Config / GUI New CLI / Config Aug 3, 2020
@36000
Copy link
Collaborator Author

36000 commented Aug 3, 2020

  • Add back in "The default values of the configuration are" thats in master.
  • Use toml instead of ini
  • Remove GUI comments
  • Generate usage.rst

@36000 36000 force-pushed the gooey branch 3 times, most recently from e507409 to 7b9d366 Compare August 5, 2020 22:36
@36000
Copy link
Collaborator Author

36000 commented Aug 6, 2020

@arokem this is ready for review

@36000 36000 force-pushed the gooey branch 2 times, most recently from fee98d4 to 9aa5cb1 Compare August 10, 2020 15:41
@36000
Copy link
Collaborator Author

36000 commented Aug 10, 2020

  • Write a unit tests that makes sure the warnings of missing docstrings don't happen.
  • Make sure lack of square brackets is handled as above.
  • use custom sphinx extensions like in dipy (make usage.rst look like a template, generate the real one with update docs)
  • change last .ini to .toml

@arokem
Copy link
Collaborator

arokem commented Aug 11, 2020

OK - this works great locally for me.

Could you please:

  1. Rebase on master
  2. Add docs/source/usage.rst to the .gitignore file? Since that one's generated automatically, we'd like to avoid tracking it.

@arokem
Copy link
Collaborator

arokem commented Aug 11, 2020

This is ready to go, I believe. I'll merge as soon as the CI comes back 🟢

@arokem arokem merged commit 7806a53 into yeatmanlab:master Aug 11, 2020
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

Successfully merging this pull request may close these issues.

None yet

3 participants