generated from CCBR/CCBR_NextflowTemplate
-
Notifications
You must be signed in to change notification settings - Fork 2
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
feat: create scripts to make champagne cli work OOTB #180
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This reverts commit 98200a9. can't easily reconcile `click` vs `Click`, `pyyaml` vs `yaml`
kelly-sovacool
added a commit
to CCBR/CHARLIE
that referenced
this pull request
May 16, 2024
kelly-sovacool
added a commit
to CCBR/CCBR_NextflowTemplate
that referenced
this pull request
Jun 26, 2024
2 tasks
kelly-sovacool
added a commit
to CCBR/RENEE
that referenced
this pull request
Aug 2, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Changes
Create
bin/champagne
(bash script) andmain.py
so that the champagne CLI will work out-of-the-box without the need to runpip install
, so long as required Python packages that are not part of the standard library are installed (currently: click & cffconvert).The Python dependencies are available in the shared py311 conda env, which can be activated before using the script:
How it works
bin/champagne
callsmain.py
, which addssrc/
to the python path and then calls the main function insrc/__main__.py
. Manually adding thissrc
dir to the path is the key ingredient that allows users to callbin/champagne
from anywhere and it will be able to import the python modules defined insrc
.Issues
resolves #179
PR Checklist
(
Strikethroughany points that are not applicable.)[ ] Write unit tests for any new features, bug fixes, or other code changes.testing framework not yet implemented[ ] Update docs if there are any API changes.on hold until before public release[ ] If a new nextflow process is implemented, define the processcontainer
andstub
.CHANGELOG.md
with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/