Skip to content

Commit 439897c

Browse files
docs: Demonstrate CLI API over running module as script
* As installation creates the executables 'bin/scikit-hep-testdata' and 'bin/skhep-testdata', demonstrate these in the README rather than running the module as a script with '-m'. - c.f. https://docs.python.org/3/using/cmdline.html#cmdoption-m
1 parent cb5dcf2 commit 439897c

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

README.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -62,15 +62,17 @@ You can also interact with this package from the command-line:
6262

6363
```bash
6464
# Print a path (download if needed)
65-
python -m skhep_testdata cms_hep_2012_tutorial/data.root
65+
skhep-testdata cms_hep_2012_tutorial/data.root
6666

6767
# Show all "local" files
68-
python -m skhep_testdata --list
68+
skhep-testdata --list
6969

7070
# Download all files to an existing directory
71-
python -m skhep_testdata --all --dir local
71+
skhep-testdata --all --dir local
7272
```
7373

74+
Note: The `scikit-hep-testdata` and `skhep-testdata` command-line tools are the equivalent of `python -m skhep_testdata`.
75+
7476
You can also use `pipx run scikit-hep-testdata` to access the above CLI without installing.
7577

7678

0 commit comments

Comments
 (0)