.. pymaketool documentation master file, created by
   sphinx-quickstart on Wed Oct  7 18:19:16 2020.
   You can adapt this file completely to your liking, but it should at least
   contain the root `toctree` directive.

pymaketool
======================================

Release v\ |version|. (:ref:`Installation <install>`)

.. image:: https://img.shields.io/pypi/l/pymaketool.svg
    :target: https://pypi.org/project/pymaketool/

.. image:: https://img.shields.io/pypi/wheel/pymaketool.svg
    :target: https://pypi.org/project/pymaketool/

.. image:: https://img.shields.io/badge/python-%3E=_3.6-green.svg
    :target: https://pypi.org/project/pymaketool/

.. image:: https://img.shields.io/github/v/tag/ericsonj/pymaketool
   :alt: GitHub tag (latest by date)

.. image:: https://github.com/ericsonj/pymaketool/workflows/Test/badge.svg?branch=master
   :alt: Test workflow

**pymaketool** is an elegant and simple tool to generate a C project with GNU Make files. 

----------------

**Behold, the power of pymaketool**

.. code-block:: python

   # app_mk.py
   from pymakelib import module

   def getSrcs(m: module.ModuleHandle):
      return m.getAllSrcsC()
   
   def getIncs(m: module.ModuleHandle):
      return m.getAllIncsC()

Or in class mode:

.. code-block:: python

   # app_mk.py
   from pymakelib import module

   @module.ModuleClass
   class mod(module.BasicCModule):
      pass

Load remote module:

.. code-block:: python

   # extlib_mk.py  
   from pymakelib import module

   @module.ModuleClass
   class ExtLib(module.ExternalModule):
      
      def getModulePath(self)->str:
         # Location of module
         return '/LIBS/module_lib/module_lib_mk.py'


**pymaketool** allow to you create C projects with anything structure extremely easily.
Use Eclipse IDE for open and edit your project, pymaketool generates the necessary files for this.

.. image:: img/pymaketool.jpg
  :width: 400
  :alt: pymaketool

----------------

**Structure of un pymaketool project**

.. image:: img/project.jpg
  :width: 700
  :alt: project


.. toctree::
   :maxdepth: 2
   
   user/install
   user/makefile.py
   user/name_mk.py
   user/user_scripts
   user/tools
   user/addons
   user/logger
   modules

.. Indices and tables
.. ==================

.. * :ref:`genindex`
.. * :ref:`modindex`
.. * :ref:`search`