parsenaut 0.2.0

🚀 Parse and launch classes as commands

Parsenaut

🚀 Parse and launch classes as commands 🚀

📦 Description

Scene-like applications may use inheritance for multiple user-defined classes in local scripts, lacking dynamic entry points and/or needing a path and class name to run. Whether your project looks something like:

from myproject import Scene


class Mandelbrot(Scene):
    """Mandelbrot example"""
    ...

class BurningShip(Scene):
    """Burning Ship example"""
    ...

One might want its usage to follow as:

# Lists all classes
$ myproject --help

📦 Scenes at (/home/user/scenes.py)
• mandelbrot      Mandelbrot example
• burningship     Burning Ship example

# Runs Mandelbrot().cli(*args)
$ myproject mandelbrot (args)

Parsenaut is a safe library for it that:

• Safe: Files are parsed with stdlib Abstract Syntax Trees and are never executed, saving import times and minimizing security issues in potentially untrusted scripts.
• Compatible: Works with Cyclopts or Typer command line libraries, at your taste.
• Flexible: Customizable class tags search, write your own implementation.
• Fast: Does not spawn a subprocess, uses stdlib runpy

📦 Installation

Simply add the parsenaut package in your pyproject.toml:

[project]
dependencies = ["parsenaut"]

📦 Usage

# myproject/__main__.py
import sys
from pathlib import Path

from parsenaut._cyclopts import Launcher

if __name__ == "__main__":
    launcher = Launcher(keyword="Scene")

    for file in Path.cwd().glob("*.py"):
        launcher.search(file)

    launcher.cli(sys.argv[1:])