Skip to content

Commit

Permalink
update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
vincentclaes committed Jan 31, 2021
1 parent 7a68753 commit 8f5e705
Show file tree
Hide file tree
Showing 2 changed files with 8 additions and 1 deletion.
6 changes: 6 additions & 0 deletions datajob/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -21,5 +21,11 @@


def call_subprocess(cmd: str) -> None:
"""
call a command as a subprocess in a secure way.
https://stackoverflow.com/a/59090212/1771155
:param cmd: the command to execute
:return: None
"""
print(f"datajob subprocess command: " f"{cmd}")
subprocess.check_call(shlex.split(cmd))
3 changes: 2 additions & 1 deletion datajob/package/wheel.py
Original file line number Diff line number Diff line change
Expand Up @@ -45,7 +45,8 @@ def _poetry_wheel(project_root: str) -> None:

def _execute_packaging_logic(project_root: str, config_file: str, cmd: str) -> None:
"""
check if the config file exists in the project root and execute the command to
create a wheel.
:param project_root: the path to the root of your project.
:param config_file: the confgi file to package the project as a wheel (setup.py or pyproject.toml)
:param cmd: the command to execute to create a wheel.
Expand Down

0 comments on commit 8f5e705

Please sign in to comment.