Skip to content

Commit 20dd957

Browse files
committed
Updated doc string for create_requirements_json to include added requirements.txt generation
1 parent b297a14 commit 20dd957

File tree

1 file changed

+9
-1
lines changed

1 file changed

+9
-1
lines changed

src/sasctl/pzmm/write_json_files.py

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1637,14 +1637,22 @@ def create_requirements_json(
16371637
environment.
16381638
16391639
When provided with an output_path argument, this function outputs a JSON file
1640-
named "requirements.json". Otherwise, a list of dicts is returned.
1640+
named "requirements.json". If create_requirements_txt is True, it will also
1641+
create a requirements.txt file. Otherwise, a list of dicts is returned.
1642+
1643+
Note: The requirements.txt file is only created when both output_path and
1644+
create_requirements_txt are specified.
16411645
16421646
Parameters
16431647
----------
16441648
model_path : str or pathlib.Path, optional
16451649
The path to a Python project, by default the current working directory.
16461650
output_path : str or pathlib.Path, optional
16471651
The path for the output requirements.json file. The default value is None.
1652+
create_requirements_txt : bool, optional
1653+
Whether to also create a requirements.txt file in addition to the
1654+
requirements.json file. This is useful for SAS Event Stream Processing
1655+
environments. The default value is False.
16481656
16491657
Returns
16501658
-------

0 commit comments

Comments
 (0)