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

Refactor the renee python package and move the GUI here #94

Merged
merged 40 commits into from
Aug 6, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
40 commits
Select commit Hold shift + click to select a range
185d9d1
feat: add gui code from ccbrpipeliner
kelly-sovacool Jan 16, 2024
1593878
refactor(gui): reorder imports, copy outside functions from ccbrpipel…
kelly-sovacool Jan 16, 2024
e5af71e
style: run pre-commit on renee
kelly-sovacool Jan 16, 2024
681722f
refactor(cli): add gui subcommand
kelly-sovacool Jan 16, 2024
e7bc290
ci: specify genome config
kelly-sovacool Jan 16, 2024
e391f46
chore: Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 2, 2024
6576721
chore: Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 2, 2024
b35eb6c
refactor: rename gui.main() to gui.launch_gui()
kelly-sovacool Aug 2, 2024
2dbc89b
chore: add gui dependencies
kelly-sovacool Aug 2, 2024
e78e72f
chore: add CCBR logo to resources
kelly-sovacool Aug 2, 2024
a0116d4
refactor: breakup main functions into separate files
kelly-sovacool Aug 2, 2024
e4df1f1
feat: make sure cli works without pip install
kelly-sovacool Aug 2, 2024
1b1446c
refactor: use relative imports everywhere
kelly-sovacool Aug 2, 2024
d70f77a
test: use ./bin/renee to invoke the CLI
kelly-sovacool Aug 2, 2024
017cc30
test: help pytest find src for python path
kelly-sovacool Aug 2, 2024
5b0d50e
fix: datetime usage
kelly-sovacool Aug 2, 2024
3d998a5
feat: set default singularity sif dir
kelly-sovacool Aug 2, 2024
0dd8131
refactor: remove most global vars, set dynamically instead
kelly-sovacool Aug 2, 2024
2ab9433
docs: update CHANGELOG.md
kelly-sovacool Aug 2, 2024
d91b173
Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 2, 2024
c212e7c
Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 5, 2024
ae56614
chore: reorder imports for linter
kelly-sovacool Aug 5, 2024
9f9e37e
test: fix import statement
kelly-sovacool Aug 5, 2024
637c9cd
refactor: optionally turn genomes warning into error for GUI
kelly-sovacool Aug 5, 2024
8e58fd5
chore: Merge branch 'refactor-renee-gui' of https://github.com/CCBR/R…
kelly-sovacool Aug 5, 2024
9430510
fix: add missing imports
kelly-sovacool Aug 5, 2024
1f77f9b
ci: remove pytest init pythonpath
kelly-sovacool Aug 5, 2024
67a235d
Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 5, 2024
d659060
Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 5, 2024
f6f751b
chore: remove reference to champagne
kelly-sovacool Aug 5, 2024
8247801
fix(cli): make sure prog name is renee
kelly-sovacool Aug 5, 2024
33b59f6
fix: tmpdir needs default option + outdir
kelly-sovacool Aug 5, 2024
9e12660
fix(gui): fix util function usage
kelly-sovacool Aug 5, 2024
68348af
fix(gui): need all subargs in NameSpace, including defaults
kelly-sovacool Aug 5, 2024
c9e9984
refactor: move run_in_context() to run submodule
kelly-sovacool Aug 5, 2024
36c52e0
refactor: default tmp dir and shared resources dir are None
kelly-sovacool Aug 5, 2024
adf6be9
refactor: write get_singularity_cache_dir()
kelly-sovacool Aug 6, 2024
d0702cc
Merge branch 'main' into refactor-renee-gui
kelly-sovacool Aug 6, 2024
db74a4f
fix: do not change fqscreen path with shared resources
kelly-sovacool Aug 6, 2024
65f07b6
fix: do not change EITHER fqscreen path with shared resources
kelly-sovacool Aug 6, 2024
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 14 additions & 3 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,22 @@
## RENEE development version

- Minor documentation improvements. (#132, #135, @kelly-sovacool)
### New features

- Support hg38 release 45 on biowulf & FRCE. (#127, @kelly-sovacool)
- Show the name of the pipeline rather than the python script for CLI help messages. (#131, @kelly-sovacool)
- Add GUI instructions to the documentation website. (#38, @samarth8392)
- Set default shared singularity SIF directory for biowulf and frce. (#94, @kelly-sovacool)
- Add `renee gui` subcommand to launch the graphical user interface. (#94, @kelly-sovacool)
- Previously, `renee_gui` (with an underscore) was a command in the `ccbrpipeliner` module.

### Bug fixes

- Ensure `renee build` creates necessary `config` directory during initialization. (#139, @kelly-sovacool)

### Documentation updates

- Minor documentation improvements. (#132, #135, @kelly-sovacool)
- Add GUI instructions to the documentation website. (#38, @samarth8392)
- The docs website now has a dropdown menu to select which version to view. The latest release is shown by default. (#150, @kelly-sovacool)
- Show the name of the pipeline rather than the python script for CLI help messages. (#131, @kelly-sovacool)

## RENEE 2.5.12

Expand Down
2 changes: 1 addition & 1 deletion bin/redirect
Original file line number Diff line number Diff line change
Expand Up @@ -67,4 +67,4 @@ elif [[ $ISFRCE == true ]];then
export PATH="/mnt/projects/CCBR-Pipelines/bin:$PATH"
fi

${TOOLDIR}/src/renee/__main__.py "$@" || true
${TOOLDIR}/main.py "$@" || true
16 changes: 16 additions & 0 deletions main.py
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
#!/usr/bin/env python
import os
import re
import sys
from src.renee.__main__ import main

# add script directory to the path to allow the CLI to work out-of-the-box
# without the need to install it via pip first
SCRIPT_DIR = os.path.join(os.path.dirname(os.path.abspath(__file__)), "src", "renee")
sys.path.append(SCRIPT_DIR)

if (
__name__ == "__main__"
): # this block is adapted from the executable file created by `pip install`
sys.argv[0] = re.sub(r"(-script\.pyw|\.exe)?$", "", sys.argv[0])
sys.exit(main())
5 changes: 3 additions & 2 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -33,12 +33,13 @@ classifiers = [
"Programming Language :: Python :: 3.9",
"Topic :: Scientific/Engineering :: Bio-Informatics",
]
requires-python = ">=3.8"
requires-python = ">=3.11"
dependencies = [
"argparse",
"Click >= 8.1.3",
"PySimpleGui < 5",
"snakemake >= 7, < 8",
"snaketool-utils >= 0.0.5",
"argparse"
]

[project.optional-dependencies]
Expand Down
Binary file added resources/CCBRlogo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file removed resources/nih-bnfo-logo.png
Binary file not shown.
Loading