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

DEV: Add make-dev-page.py #257

Merged
merged 4 commits into from
Jul 14, 2020
Merged

DEV: Add make-dev-page.py #257

merged 4 commits into from
Jul 14, 2020

Conversation

ElDeveloper
Copy link
Member

This creates a development page of Empress (optionally a tandem plot)
using the moving pictures tutorial data. To see changes from the
JavaScript and CSS files you can reload the generated page from the web
browser.

In the animated GIF below, I show how to see changes to the source by reloading the page (initially the log message is not visible in the console):

dev-cycle

Fixes #242

This creates a development page of Empress (optionally a tandem plot)
using the moving pictures tutorial data. To see changes from the
JavaScript and CSS files you can reload the generated page from the web
browser.

Fixes biocore#242
@ElDeveloper ElDeveloper requested a review from kwcantrell July 14, 2020 01:34
@kwcantrell
Copy link
Collaborator

@ElDeveloper thanks for adding this! I think this will help improve the development experience! Would it be possible to have the data set be a parameter? I have a couple datasets I like to test with.

All inputs are parametric through a click interface.
@ElDeveloper
Copy link
Member Author

@kwcantrell, great suggestion that's very handy. I just added the CLI configuration to make this possible. If no arguments are set then the moving pictures dataset is loaded. I also added a couple of calls to .travis.yml so we check that this works as the code evolves.

Copy link
Collaborator

@kwcantrell kwcantrell left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@ElDeveloper thanks again for adding this. It will be a huge quality of life improvement. I just have one minor comment and I then I think this can be merged

CONTRIBUTING.md Outdated
Comment on lines 33 to 44
## Front-end development

For convenience, a utility script `./tests/python/make-dev-page.py` is bundled
in the test suite. If no arguments are set, the script will load the moving
pictures dataset and create a page `development-page.html`. Using this page
developers can modify CSS and JS files and simply reload the page on the
browser to see their changes take effect.

Note, modifications to the Python code, or the template code require that you
re-run the script. For a full list of options and arguments, you can run
`./tests/python/make-dev-page.py --help`.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can you modify this file to tell users to use pip install -e .

This script wasn't working for me because I used pip install .

@kwcantrell
Copy link
Collaborator

Thanks @ElDeveloper

@kwcantrell kwcantrell merged commit 0ca08b7 into biocore:master Jul 14, 2020
@ElDeveloper
Copy link
Member Author

ElDeveloper commented Jul 14, 2020 via email

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.

Streamline development process
2 participants