Skip to content

Latest commit

 

History

History
168 lines (116 loc) · 3.74 KB

README.md

File metadata and controls

168 lines (116 loc) · 3.74 KB
Raw

Moduler

Moduler helps make the skeletons of your Python project more readable by making it sparse and meta-annotated.

In Moduler, you can

  • Add sections to your functions, classes and modules without refactoring
  • Add semantic annotation to your codes. This includes
    • Add examples to your existing codes
    • Add todos for incomplete codes

We believe in this way we can provide much more context information to new contributors who are not familiar with the codebase. It is also important for AI-based agents to understand the codebase and develop it.

How to use

Sections

Putting sections in Moduler is as easy as putting sections in Markdown. You just need to put a # before your section title in a comment environment starting with """. For example,

"""
# Section 1
The following is a function.
"""


def foo():
    pass


"""
# Section 2
The following is another function.
"""


def bar():
    pass

In this way, foo() and bar() will have sections Section 1 and Section 2 respectively. The sections will also contain the comments under them.

Your section can also contain classes add levels. For example,

"""
# Top Section
## Section 1
"""


class Foo:
    """
    # Section 1
    The following is a function.
    """

    def foo(self):
        pass

    """
    # Section 2
    The following is another function.
    """

    def bar(self):
        pass


"""
## Section 2
"""


def baz():
    pass

Section in folder

You add .tree.yml file in a folder to add sections in it. For example, in the following folder

a_folder
- __init__.py
- a.py
- b.py
- c.py
- .tree.yml

You can put a,b in a section by putting

sections:
 your section title:
   - a
   - b
default section: you default section title

Then a and b will be in the section your section title and c will be in the section you default section title.

Mark examples

You can also add examples to your functions and classes. Just use the @example decorator. For example,

from moduler.decorator import example


@example
def how_to_use_foo():
    """
    The following is an example of using `foo()`.
    """
    foo()

Mark todos

In a similar way, you can also mark todos in your code. Just use the @todo decorator. For example,

from moduler.decorator import todo


@todo
def todo_foo():
    """
    The following is a todo.
    """
    foo()


@todo("This function is buggy. Fix it.")
def buggy_foo():
    foo(a=b)

Visualize your codebase

You can put the function draw_module_tree() in any of your modules to visualize the tree structure generated from it. Call it in the __init__.py of your package is recommended.

Installation

You can install Moduler by

pip install git+https://github.com/EvoEvolver/Moduler.git

Philosophy behind Moduler

Sparse tree structure

All the programming languages encourage the programmers to put their code in the tree structure. For example, you can put your functions in difference classes, in different files and put the files in different folders. However, it is still very common to put a lot of functions in a single file, in which the codes are arranged in an almost flat structure.

Moduler helps this by adding a zero-cost way to add sections to your functions and classes. It makes another step towards a more tree-like structure of the codebase. We believe this will help the programmers to understand the codebase better.

Literate programming

Moduler can be regarded as an effort toward the idea - literate programming. We think literate programming gets even more important in the era of AI for it provides more context information for AI-based agents to understand the codebase.