From fae01cd246577404ae9cdec2173d22d2d01cc0ca Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Wed, 19 Nov 2025 23:42:47 -0700 Subject: [PATCH 1/3] 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 --- README.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d468992..aa79ffe 100644 --- a/README.md +++ b/README.md @@ -62,15 +62,17 @@ You can also interact with this package from the command-line: ```bash # Print a path (download if needed) -python -m skhep_testdata cms_hep_2012_tutorial/data.root +skhep-testdata cms_hep_2012_tutorial/data.root # Show all "local" files -python -m skhep_testdata --list +skhep-testdata --list # Download all files to an existing directory -python -m skhep_testdata --all --dir local +skhep-testdata --all --dir local ``` +Note: The `scikit-hep-testdata` and `skhep-testdata` command-line tools are the equivalent of `python -m skhep_testdata`. + You can also use `pipx run scikit-hep-testdata` to access the above CLI without installing. From d0796ab425bdfc7ce7c3cc89bca22dff37c01c50 Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Wed, 19 Nov 2025 23:54:54 -0700 Subject: [PATCH 2/3] docs: Add 'uvx' and 'pixi exec' examples to README * Show how to use 'uvx', 'pipx', and 'pixi exec' to be able to access and use the CLI API without having to explicitly install into an environment. --- README.md | 20 +++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index aa79ffe..a71ee96 100644 --- a/README.md +++ b/README.md @@ -73,7 +73,25 @@ skhep-testdata --all --dir local Note: The `scikit-hep-testdata` and `skhep-testdata` command-line tools are the equivalent of `python -m skhep_testdata`. -You can also use `pipx run scikit-hep-testdata` to access the above CLI without installing. +You can also use any of the following to access the above CLI without installing. + +* uv: + +``` +uvx scikit-hep-testdata +``` + +* pipx: + +``` +pipx run scikit-hep-testdata +``` + +* Pixi: + +``` +pixi exec scikit-hep-testdata +``` ## Adding new files From 298e25e2bfe94642eb81368e136352073ff13d29 Mon Sep 17 00:00:00 2001 From: Matthew Feickert Date: Wed, 26 Nov 2025 14:05:02 -0700 Subject: [PATCH 3/3] style: Remove syntax highlighting hints that don't match block language --- README.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index a71ee96..d6d8f46 100644 --- a/README.md +++ b/README.md @@ -20,13 +20,13 @@ get larger files from common open-access data repositories. ## Installing and usage To install: -```bash +``` python -m pip install scikit-hep-testdata ``` Once installed, absolute file paths can be resolved using the helper methods: -``` python +```python from skhep_testdata import data_path filename = data_path("some_file.root") @@ -60,7 +60,7 @@ files. ### Command-line invocation You can also interact with this package from the command-line: -```bash +``` # Print a path (download if needed) skhep-testdata cms_hep_2012_tutorial/data.root @@ -166,6 +166,6 @@ This project follows the [all-contributors](https://github.com/all-contributors/ This package uses `pytest` to run the unit tests. Install with `pip install scikit-hep-testdata[test]` or `pip install -e .[test]` (dev) to get the testing requirements. then run: -```bash +``` pytest ```