File tree 1 file changed +18
-3
lines changed
1 file changed +18
-3
lines changed Original file line number Diff line number Diff line change @@ -49,17 +49,32 @@ Install from `PyPI <https://pypi.org/project/hepdata-validator/>`_ using ``pip``
49
49
$ pip install --user hepdata-validator
50
50
$ hepdata-validate --help
51
51
52
- Install from GitHub (for developers) in a `virtual environment <https://docs.python.org/3/tutorial/venv.html >`_:
52
+ If you would like to use LibYAML, you may need an additional step if running on an M1 Mac, to ensure pyyaml is built
53
+ with the LibYAML bindings. Run the following after installing LibYAML via Homebrew:
54
+
55
+ .. code :: bash
56
+
57
+ $ LDFLAGS=" -L$( brew --prefix) /lib" CFLAGS=" -I$( brew --prefix) /include" pip install --global-option=" --with-libyaml" --force pyyaml
58
+
59
+
60
+ Developers
61
+ ==========
62
+ Developers should install from GitHub in a `virtual environment <https://docs.python.org/3/tutorial/venv.html >`_:
53
63
54
64
.. code :: bash
55
65
56
66
$ git clone https://github.com/HEPData/hepdata-validator
57
67
$ cd hepdata-validator
58
68
$ python3 -m venv ~ /venv/hepdata-validator
59
69
$ source ~ /venv/hepdata-validator/bin/activate
60
- (hepdata-validator) $ pip install --upgrade -e .[tests]
61
- (hepdata-validator) $ pytest testsuite
70
+ (hepdata-validator) $ pip install --upgrade -e " .[tests]"
71
+
72
+ Tests should be run both with and without LibYAML, as error messages from the different YAML parsers vary:
73
+
74
+ .. code :: bash
62
75
76
+ (hepdata-validator) $ USE_LIBYAML=True pytest testsuite
77
+ (hepdata-validator) $ USE_LIBYAML=False pytest testsuite
63
78
64
79
Usage
65
80
-----
You can’t perform that action at this time.
0 commit comments