piel.cli.develop#

Functions#

`return_path`(→ pathlib.Path)	Returns a pathlib.Path to be able to perform operations accordingly internally.
`echo_and_check_subprocess`(command, **kwargs)	Runs a subprocess and prints the command. Raises an exception if the subprocess fails.
`get_python_install_directory`()	Gets the piel installation directory.
`main`([args])	CLI Interface for piel There are available many helper commands to help you set up your
`develop`()	Development related commands.
`build_documentation`([args])	Verifies and builds the documentation.
`generate_poetry2nix_flake`([args])	Generates the poetry2nix flakes file. Requires nix to be installed.
`build_piel_cachix_command`([args])	Enters the custom piel nix environment with all the supported tools installed and configured packages.

Module Contents#

return_path(input_path: piel.types.PathTypes, as_piel_module: bool = False) → pathlib.Path[source]#

Returns a pathlib.Path to be able to perform operations accordingly internally.

This allows us to maintain compatibility between POSIX and Windows systems. When the as_piel_module flag is enabled, it will analyse whether the input path can be treated as a piel module, and treat the returned path as a module would be treated. This comes useful when analysing data generated in this particular structure accordingly.

Usage:

return_path(‘path/to/file’)

Parameters:: input_path (str) – Input path.
Returns:: Pathlib path.
Return type:: pathlib.Path

echo_and_check_subprocess(command: list, **kwargs)[source]#

Runs a subprocess and prints the command. Raises an exception if the subprocess fails.

Parameters:

command –
**kwargs –

Returns:

get_python_install_directory()[source]#

Gets the piel installation directory.

Returns:: The piel installation directory.
Return type:: pathlib.Path

main(args=None)#: CLI Interface for piel There are available many helper commands to help you set up your environment and design your projects.

develop()#: Development related commands.

build_documentation(args=None)#: Verifies and builds the documentation.

generate_poetry2nix_flake(args=None)#

Generates the poetry2nix flakes file. Requires nix to be installed.

Returns:

build_piel_cachix_command(args=None)#: Enters the custom piel nix environment with all the supported tools installed and configured packages. Runs the nix-shell command on the piel/environment/nix/ directory.