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

feat: create scripts to make champagne cli work OOTB #180

Merged
merged 10 commits into from
Jun 26, 2024
Merged

Conversation

kelly-sovacool
Copy link
Member

@kelly-sovacool kelly-sovacool commented Feb 20, 2024

Changes

Create bin/champagne (bash script) and main.py so that the champagne CLI will work out-of-the-box without the need to run pip 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:

. "/data/CCBR_Pipeliner/db/PipeDB/Conda/etc/profile.d/conda.sh"
conda activate py311
bin/champagne --help

How it works

bin/champagne calls main.py, which adds src/ to the python path and then calls the main function in src/__main__.py. Manually adding this src dir to the path is the key ingredient that allows users to call bin/champagne from anywhere and it will be able to import the python modules defined in src.

Issues

resolves #179

PR Checklist

(Strikethrough any points that are not applicable.)

  • This comment contains a description of changes with justifications, with any relevant issues linked.
  • [ ] 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 process container and stub.
  • Update CHANGELOG.md with a short description of any user-facing changes and reference the PR number. Guidelines: https://keepachangelog.com/en/1.1.0/

@kelly-sovacool kelly-sovacool marked this pull request as ready for review February 20, 2024 21:59
kelly-sovacool added a commit to CCBR/CHARLIE that referenced this pull request May 16, 2024
@kelly-sovacool kelly-sovacool merged commit 61fe191 into main Jun 26, 2024
1 of 3 checks passed
@kelly-sovacool kelly-sovacool deleted the cli-ootb branch June 26, 2024 13:02
kelly-sovacool added a commit to CCBR/CCBR_NextflowTemplate that referenced this pull request Jun 26, 2024
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
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Implement bin/redirect/bin/champagne script to work out of the box
1 participant