Skip to content

Commit ff4989d

Browse files
committed
add more precise instructions to the dac pack command
1 parent 0bae280 commit ff4989d

File tree

1 file changed

+15
-0
lines changed

1 file changed

+15
-0
lines changed

src/dac/_cli.py

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -58,6 +58,21 @@ def pack(
5858
"""
5959
Build a Data as Code (DaC) python wheel after verifying that data
6060
can be loaded and that data respect the provided schema.
61+
62+
This command should be used in a python environment that contains
63+
all the dependencies needed to load the data and to validate the schema.
64+
65+
This means that before running this command, you should run something like:
66+
67+
```sh
68+
69+
python -m venv venv && . venv/bin/activate
70+
python -m pip install dac -r requirements.txt
71+
72+
```
73+
74+
where the `requirements.txt` file is the same that you are going to provide
75+
in the `--dependencies` argument.
6176
"""
6277
py_api_pack(
6378
config=PackConfig(

0 commit comments

Comments
 (0)