:py:mod:`mloq.commands.project`
===============================

.. py:module:: mloq.commands.project

.. autoapi-nested-parse::

   Mloq project command implementation.



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

Classes
~~~~~~~

.. autoapisummary::

   mloq.commands.project.ProjectCMD




Attributes
~~~~~~~~~~

.. autoapisummary::

   mloq.commands.project.PROJECT_ASSETS_PATH
   mloq.commands.project.readme
   mloq.commands.project.gitignore
   mloq.commands.project.pre_commit_hook
   mloq.commands.project.init
   mloq.commands.project.main
   mloq.commands.project.test_main
   mloq.commands.project.test_req
   mloq.commands.project.version
   mloq.commands.project.code_of_conduct
   mloq.commands.project.codecov
   mloq.commands.project.contributing
   mloq.commands.project.PROJECT_FILES


.. py:data:: PROJECT_ASSETS_PATH
   

   

.. py:data:: readme
   

   

.. py:data:: gitignore
   

   

.. py:data:: pre_commit_hook
   

   

.. py:data:: init
   

   

.. py:data:: main
   

   

.. py:data:: test_main
   

   

.. py:data:: test_req
   

   

.. py:data:: version
   

   

.. py:data:: code_of_conduct
   

   

.. py:data:: codecov
   

   

.. py:data:: contributing
   

   

.. py:data:: PROJECT_FILES
   

   

.. py:class:: ProjectCMD(record, interactive = False, **kwargs)

   Bases: :py:obj:`mloq.command.Command`

   Implement the functionality of the project Command.

   .. py:attribute:: cmd_name
      :annotation: = project

      

   .. py:attribute:: files
      

      

   .. py:attribute:: disable
      

      

   .. py:attribute:: project_name
      

      

   .. py:attribute:: owner
      

      

   .. py:attribute:: description
      

      

   .. py:attribute:: project_url
      

      

   .. py:attribute:: license
      

      

   .. py:attribute:: tests
      

      

   .. py:method:: directories()
      :property:

      Tuple containing Paths objects representing the directories created by the command.


   .. py:method:: record_files()

      Register the files that will be generated by mloq.