maxx
maxx (MATLAB Language Tools) is a Python library for parsing and analyzing MATLAB code. It provides comprehensive support for extracting signatures, documentation, and metadata from MATLAB projects including functions, classes, scripts, and packages.
Features
- 🔍 Parse MATLAB files - Extract functions, classes, properties, and methods
- 📁 Project structure analysis - Handle MATLAB packages, namespaces, and class folders
- 📖 Documentation extraction - Parse docstrings and comments from MATLAB code
- 🎯 Type information - Extract argument types, validation functions, and return types
- 🌳 Tree-sitter based - Fast and accurate parsing using tree-sitter-matlab
- 🔗 Integration ready - Built for documentation generators like MkDocs
Installation
Using pip:
pip install maxx
Using uv:
uv add maxx
Quick Start
Basic File Parsing
from pathlib import Path
from maxx.treesitter import FileParser
# Parse a MATLAB function file
parser = FileParser(Path("myfunction.m"))
matlab_object = parser.parse()
print(f"Object type: {matlab_object.kind}")
print(f"Name: {matlab_object.name}")
print(f"Arguments: {matlab_object.arguments}")
print(f"Docstring: {matlab_object.docstring}")
Project Collection
from maxx.collection import PathsCollection
from pathlib import Path
# Collect all MATLAB objects from a project
paths = PathsCollection([Path("src"), Path("examples")])
# Access parsed objects
my_function = paths["myfunction"]
my_class = paths["MyClass"]
my_package = paths["+mypackage.MyFunction"]
Working with Classes
# Access class members
matlab_class = paths["MyClass"]
print(f"Base classes: {matlab_class.bases}")
print(f"Properties: {list(matlab_class.members.keys())}")
# Access methods and properties
constructor = matlab_class.constructor
properties = [m for m in matlab_class.members.values() if m.is_property]
Supported MATLAB Constructs
- Functions - Regular functions, nested functions, methods
- Classes - Class definitions, properties, methods, inheritance
- Scripts - Script files and their documentation
- Packages - Namespace packages (
+package) and class folders (@class) - Arguments blocks - Input/output validation and type information
- Properties blocks - Class properties with attributes and validation
License
This project is licensed under the GPL-3.0 License - see the LICENSE file for details.
Metadata
Release files for maxx 0.11.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| maxx-0.11.0.tar.gz | 926.9 kB | Without provenance | Details for maxx-0.11.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| maxx-0.11.0-py3-none-any.whl | Python 3 | none | any | Details for maxx-0.11.0-py3-none-any.whl |
Total release size: 1.0 MB
Release files / maxx-0.11.0.tar.gz
| Download URL | maxx-0.11.0.tar.gz |
|---|---|
| Size | 926.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
cb04bbb89909aedfe00c54d7cf9ca8fad57d7e2de882983d61cc6e04a2b5574b
|
|
BLAKE2b-256 checksum How to use checksums |
5f92322e22988b08bc9504f1d7808f3f98f52c6b4752985b0787d52eae5b101c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / maxx-0.11.0-py3-none-any.whl
| Download URL | maxx-0.11.0-py3-none-any.whl |
|---|---|
| Size | 82.9 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
87b8bcba6253e7784e7c9d195fb813d11af77236467dfc28db84cdd8ce9386c0
|
|
BLAKE2b-256 checksum How to use checksums |
b43de20944688669edceca399715172719cd19918f5515dc2333992cbf8d983c
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.13.6 {"installer":{"name":"uv","version":"0.13.6","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"26.04","id":"resolute","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for maxx 0.11.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.