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

Improve docs with regards to running and testing workflows #1426

Open
wants to merge 4 commits into
base: master
Choose a base branch
from

Conversation

wm75
Copy link
Contributor

@wm75 wm75 commented Jan 31, 2024

No description provided.

- Renamed chapter "Interacting with Galaxy workflows"
  since it's covering a lot more than just planemo run.

- Introduced a few, new subheadings

- Hopefully improved explanation of workflow testing with planemo test
@wm75
Copy link
Contributor Author

wm75 commented Jan 31, 2024

@mvdbeek you asked me to take a look at the documentation of planemo run.

I've added some smaller improvements here, but imo the biggest hurdle when trying to understand the documentation is not so much the content of individual chapters, but their outline.
Depending on your entry point into the docs they can be very confusing. If you take a look at the sidebar, there is little logic in (but likely a lot of history behind) how chapters are organized and the titles are often misleading.
I would really start there.

@wm75
Copy link
Contributor Author

wm75 commented Jan 31, 2024

More specifically, I'd ask what different things you can do with planemo and what people coming to the docs might be looking for: something like develop/test tools, interact with workflows, interacting with the tool shed, then use these as main topics and add sub-chapters for each.

@wm75
Copy link
Contributor Author

wm75 commented Jan 31, 2024

The chapter on "Running", now "Interacting with" workflows is actually rather good on its own. "Automating Galaxy workflows" on the other hand is very redundant with "Running", "Test Format" and "Best Practices for Maintaining Galaxy Workflows", and hardly worth keeping in its current form. We could think of documenting the large-scale SARS-CoV-2 automation there perhaps.

@wm75
Copy link
Contributor Author

wm75 commented Feb 1, 2024

I've noticed that the simple planemo workflow_edit tutorial.ga suggested early in https://planemo.readthedocs.io/en/latest/running.html#the-basics does not work without some profile information, presumably because you cannot access workflow editor functionality as an anonymous user?
Suggestions how to rewrite this would be appreciated.

Here's the error message I'm getting with the command:

Traceback (most recent call last):
  File "/home/wolma/planemo_39/bin/planemo", line 8, in <module>
    sys.exit(planemo())
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 1157, in __call__
    return self.main(*args, **kwargs)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 1078, in main
    rv = self.invoke(ctx)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 1688, in invoke
    return _process_result(sub_ctx.command.invoke(sub_ctx))
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 1434, in invoke
    return ctx.invoke(self.callback, **ctx.params)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/decorators.py", line 92, in new_func
    return ctx.invoke(f, obj, *args, **kwargs)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/click/core.py", line 783, in invoke
    return __callback(*args, **kwargs)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/planemo/cli.py", line 102, in handle_blended_options
    return f(*args, **kwds)
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/planemo/commands/cmd_workflow_edit.py", line 21, in cli
    runnable = for_runnable_identifier(ctx, workflow_identifier, kwds.get("profile"))
  File "/home/wolma/planemo_39/lib64/python3.9/site-packages/planemo/runnable_resolve.py", line 21, in for_runnable_identifier
    current_profile = kwds.get("profile")
AttributeError: 'NoneType' object has no attribute 'get'

@mvdbeek mvdbeek mentioned this pull request Feb 1, 2024
@mvdbeek
Copy link
Member

mvdbeek commented Feb 1, 2024

I'll try fixing that up, however I think we should have people testing workflows from the IWC, not https://github.com/usegalaxy-eu/workflow-testing, which I think isn't very active or easily debuggable.

@mvdbeek
Copy link
Member

mvdbeek commented Feb 1, 2024

The fix was pretty simple, no profile required, I'll merge and cut a new release once the tests pass.

@mvdbeek
Copy link
Member

mvdbeek commented Feb 8, 2024

Sorry, got distracted a little. https://pypi.org/project/planemo/0.75.21/ should work for workflow_edit, though we should enable the prebuilt-client install to speed up planemo serve.

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.

2 participants