piel.cli.develop
================

.. py:module:: piel.cli.develop


Functions
---------

.. autoapisummary::

   piel.cli.develop.return_path
   piel.cli.develop.echo_and_check_subprocess
   piel.cli.develop.get_python_install_directory
   piel.cli.develop.main
   piel.cli.develop.develop
   piel.cli.develop.build_documentation
   piel.cli.develop.generate_poetry2nix_flake
   piel.cli.develop.build_piel_cachix_command


Module Contents
---------------

.. py:function:: return_path(input_path: piel.types.PathTypes, as_piel_module: bool = False) -> pathlib.Path

   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')

   :param input_path: Input path.
   :type input_path: str

   :returns: Pathlib path.
   :rtype: pathlib.Path


.. py:function:: echo_and_check_subprocess(command: list, **kwargs)

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

   :param command:
   :param \*\*kwargs:

   Returns:



.. py:function:: get_python_install_directory()

   Gets the piel installation directory.

   :returns: The piel installation directory.
   :rtype: pathlib.Path


.. py:function:: main(args=None)

   CLI Interface for piel There are available many helper commands to help you set up your
   environment and design your projects.


.. py:function:: develop()

   Development related commands.


.. py:function:: build_documentation(args=None)

   Verifies and builds the documentation.


.. py:function:: generate_poetry2nix_flake(args=None)

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

   Returns:



.. py:function:: 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.