mosheh 1.1.0

Mosheh, a tool for creating docs for projects, from Python to Python.

Mosheh

Mosheh, a tool for creating docs for projects, from Python to Python.

Basically, Mosheh lists all files you points to, saves every single notorious statement of definition on each file iterated, all using Python ast native module for handling the AST and then generating with MkDocs and Material MkDocs a documentation respecting the dirs and files hierarchy. The stuff documented for each file are listed below:

• Imports [ast.Import | ast.ImportFrom]

  • Type [Native | TrdParty | Local]
  • Path (e.g. 'django.http')
  • Code

• Constants [ast.Assign | ast.AnnAssign]

  • Name (token name)
  • Typing Notation (datatype)
  • Value (literal or call)
  • Code

• Classes [ast.ClassDef]

  • Description (docstring)
  • Name (class name)
  • Parents (inheritance)
  • Methods Defined (nums and names)
  • Example (usage)
  • Code

• Funcs [ast.FunctionDef | ast.AsyncFunctionDef]

  • Description (docstring)
  • Name (func name)
  • Type [Func | Method | Generator | Coroutine]
  • Parameters (name, type, default)
  • Return Type (datatype)
  • Raises (exception throw)
  • Example (usage)
  • Code

• Assertions [ast.Assert]

  • Test (assertion by itself)
  • Message (opt. message in fail case)
  • Code

Stack

ToDo List

• Evaluate use of Rust for better proccessing
• Evaluate the processing of more files than just Python ones (e.g. .txt, .toml)
• Migrate dependency system to use UV
• Accept structured file (e.g. mosheh.json) as parameters replacement
• Provide an "exclude" config for files/dirs to ignore
• Insert tags for .md based on their names/contexts
• Get and list all metrics of above's statements featured
• Check for files docstrings and write below filepath
• Create detail page for classes with docstring and listing class constants and methods
• Create detail page for functions with docstring and body detail

Arch

Mosheh's architecture can be interpreted in two ways: the directory structure and the interaction of the elements that make it up. A considerable part of a project is - or at least should be - that elements that are dispensable for its functionality are in fact dispensable, such as the existence of automated tests; they are important so that any existing quality process is kept to a minimum acceptable level, but if all the tests are deleted, the tool still works.

Here it is no different, a considerable part of Mosheh is, in fact, completely dispensable; follow below the structure of directories and relevant files that are part of this project:

.
├── setup.py                    # PyPI build's config file
│
├── mosheh                      # Mosheh's source-code
│   ├── codebase.py             # Codebase reading logic
│   ├── constants.py            # Constants to be evaluated
│   ├── custom_types.py         # Custom data types
│   ├── doc.py                  # Documentation build logic
│   ├── handlers.py             # Codebase nodes handlers functions
│   ├── main.py                 # Entrypoint
│   └── utils.py                # Utilities
│
├── tests                       # Template dir for testing
│   ├── DOC                     # Doc output dir
│   └── PROJECT                 # Template project dir
│
├── documentation               # Mosheh's documentation dir
│   ├── docs                    # Dir containing .md files and assets
│   └── mkdocs.yml              # MkDocs config file
│
├── requirements.txt            # Mosheh's dependencies
│
├── .github                     # Workflows and social stuff
│
├── LICENSE                     # Legal stuf, A.K.A donut sue me
│
├── ruff.toml                   # Ruff config file
│
└── .gitignore                  # Git "exclude" file

It is to be expected that if the tests/ directory is deleted, Mosheh itself will not be altered in any way, so much so that when a tool is downloaded via pip or similar, the tool is not accompanied by tests, licenses, development configuration files or workflows. So, to help you understand how the mosheh/ directory works, here's how the functional elements interact with each other:

Usage

Local Build and Installation

pip install -r requirements.txt  # Install all dependencies in your local environment

# or

pip install wheel setuptools  # Install only build dependencies in your local environment

python3 setup.py sdist bdist_wheel  # Build pip-like file

pip install dist/mosheh-<VERSION>-py3-none-any.whl --force-reinstall  # Install Mosheh using generated pip-like file

Running

mosheh [-h] -root ROOT \
      [--repo-name REPO_NAME] \
      [--repo-url REPO_URL] \
      [--edit-uri EDIT_URI] \
      [--logo-path LOGO_PATH] \
      [--readme-path README_PATH] \
      [--exit EXIT]

Parameters

Call	Type	Mandatory	Default	Example	Description
-h, --help	str	Optional	None	-h, --help	Help message
-root	str	Required	None	-root example/	Root dir, where the analysis starts.
--repo-name	str	Optional	'GitHub'	--repo-name toicin	Name of the code repository to be mapped.
--repo-url	str	Optional	'https://github.com/'	--repo-url https://random.com	URL of the code repository to be mapped.
--edit-uri	str	Optional	'blob/main/documentation/docs'	--edit-uri blob/main/docs	URI to view raw or edit blob file.
--logo-path	str	Optional	None	--repo-url .github/logo.svg	Path for doc/project logo, same Material MkDocs's formats.
--readme-path	str	Optional	None	--repo-url .github/README.md	Path for README.md file to used as homepage.
--output	str	Optional	'.'	--output doc/	Path for documentation output, where to be created.

License

This project is under MIT License. A short and simple permissive license with conditions only requiring preservation of copyright and license notices. Licensed works, modifications, and larger works may be distributed under different terms and without source code.