Skip to content

Commit

Permalink
fixes #81
Browse files Browse the repository at this point in the history
  • Loading branch information
JohannesWiesner committed Feb 20, 2024
1 parent daae5e0 commit 23e049d
Show file tree
Hide file tree
Showing 4 changed files with 8 additions and 5 deletions.
3 changes: 3 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,6 @@ __pycache__/
# ignore any .tsv or .yml files
*.tsv
*.yml

# ignore lock files created by spreadsheet programs
.~lock*.tsv
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@ The following **optional arguments** can be set for further customization:
### The packages.tsv file
The input spreadsheet file needs to have the following columns:
- `package_name` (the offical name of the package)
- `version` (specify the version of the package you need, this can include )
- `version` (specify the version of the package you need by following the [package match specification syntax](https://docs.conda.io/projects/conda-build/en/latest/resources/package-spec.html#package-match-specifications))
- `installation_command` (the full installation command)
- `package_manager` (pip, conda, cran)
- `conda_channel` (which conda channel to install from)
Expand All @@ -62,7 +62,7 @@ The input spreadsheet file needs to have the following columns:
- `necessity` ("required": you find that this package should be available for all lab members, "optional": only you need it for your current project but maybe any future lab member might find it also useful in the future)
- `description` (a short description of what this package does)
- `comment` (optional comments if something is buggy or if you want to tell other users some useful information)
- `language` (Python, R, Julia)
- `language` (python, r, julia)
- `bug_flag` (can be 'linux','windows' or 'cross_platform')

### Automatic testing of the datasets.tsv file
Expand Down
4 changes: 2 additions & 2 deletions tcy.py
Original file line number Diff line number Diff line change
Expand Up @@ -68,7 +68,7 @@ def run(operating_system,yml_name=None,yml_file_name='environment.yml',pip_requi
A valid URL to a CRAN-Mirror where packages should be downloaded from.
The default is 'https://cloud.r-project.org'
languages: str or list of str, optional
Filter for languages. Valid arguments are Python, Julia, R.
Filter for languages. Valid arguments are python, julia, r, or all.
The default is 'all'
necessity: str or list of str, optional
Filter for necessity. Valid arguments are optional, required.
Expand Down Expand Up @@ -255,7 +255,7 @@ def run(operating_system,yml_name=None,yml_file_name='environment.yml',pip_requi
The default is \'https://cloud.r-project.org\'")
parser.add_argument('--languages',type=str,required=False,default='all',nargs='+',
help="Filter for certain programming languages. Valid inputs \
are Python, R, Julia.")
are python, julia, r or all.")
parser.add_argument('--necessity',type=str,required=False,default='all',nargs='+',
help="Filter for necessity. Valid inputs are \'required\', \'optional\', or \'all\'. \
The default is \'all\'")
Expand Down
2 changes: 1 addition & 1 deletion test_configs.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"valid_columns": ["package_name", "version", "installation_command", "package_manager", "conda_channel", "area","link", "necessity", "description", "comment", "language", "bug_flag"],
"filled_out_columns": ["package_name","language"],
"valid_options": {"package_manager":["conda","pip","cran"],"language":["Python","R","Julia"],"bug_flag":["linux","windows","cross-platform"]},
"valid_options": {"package_manager":["conda","pip","cran"],"language":["python","r","julia"],"bug_flag":["linux","windows","cross-platform"]},
"column_dependencies": null,
"multi_option_columns": null
}
Expand Down

0 comments on commit 23e049d

Please sign in to comment.