.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

whiteprints.cli.init
====================

.. py:module:: whiteprints.cli.init

.. autoapi-nested-parse::

   Initialize a project.



Exceptions
----------

.. autoapisummary::

   whiteprints.cli.init.CopierCopyError


Functions
---------

.. autoapisummary::

   whiteprints.cli.init.init


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

.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

.. py:exception:: CopierCopyError

   Bases: :py:obj:`click.ClickException`


   An error occured while creating the project.


   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:attribute:: exit_code
      :value: 1



   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:attribute:: show_color
      :type:  Optional[bool]


   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:attribute:: message


   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:method:: format_message() -> str


   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:method:: __str__() -> str

      Return str(self).



   .. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
   .. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
   ..
   .. SPDX-License-Identifier: MIT

   .. py:method:: show(file: Optional[IO[Any]] = None) -> None


.. SPDX-FileCopyrightText: © 2015 Read the Docs, Inc
.. SPDX-FileCopyrightText: © 2024 The "Whiteprints" contributors <whiteprints@pm.me>
..
.. SPDX-License-Identifier: MIT

.. py:function:: init(project_directory: pathlib.Path, copier_args: collections.abc.Iterable[str], **kwargs: Unpack[whiteprints.cli.init_interface.InitKwargs]) -> None

   Initialize a python project.

   :param project_directory: directory the new project will be created.
   :param copier_args: arguments forwarded to copier.
   :param kwargs: the command line flags.

   :raises CopierCopyError: An error happened while creating the project.