entrypoint2

1.1 · active · verified Wed Apr 15

Entrypoint2 is an easy-to-use command-line interface for Python modules. It translates function signatures and documentation directly into `argparse` configurations, simplifying CLI creation. The current version is 1.1. Releases appear to be infrequent and event-driven, rather than on a fixed cadence.

Warnings

breaking Older versions of `entrypoint2` or its predecessor, `entrypoint`, had known issues with Python 3 compatibility. Version 1.1 and later explicitly support Python 3.6 to 3.12 and are Python 3 'only'. Projects targeting Python 2 should use older, unmaintained versions at their own risk.
Fix: Ensure you are using `entrypoint2` version 1.1 or higher for Python 3 projects. Migrate Python 2 code if necessary.
gotcha Parameter type conversion is inferred from default argument values in the function signature. If a parameter has no default value, it is treated as a string by default. This can lead to unexpected type errors at runtime if a different type is expected and no default is provided.
Fix: Always provide a default value with the desired type (e.g., `def func(count=0):`) or explicitly cast the argument within your function if a default is not suitable.
gotcha Automatic short flags (e.g., `-m` for `--message`) are generated from the first letter of a parameter. However, if multiple parameters start with the same letter, only the first one encountered will receive a short flag. Subsequent parameters with the same initial letter will not have a short flag.
Fix: Avoid starting multiple parameters with the same letter if you rely on automatic short flag generation, or explicitly define short flags using `entrypoint`'s advanced options (if available, consult documentation) if unique short flags are critical.
gotcha The `--version` flag automatically attempts to read the version from `__version__`, `VERSION`, or `version` variables defined in the module. If multiple such variables exist, the order of precedence is not strictly documented and might lead to an unexpected version string being displayed.
Fix: To ensure correct version reporting, define only one of `__version__`, `VERSION`, or `version` in your module, or explicitly pass the version string to the decorator if such an option is provided (consult official documentation).

Install

pip install entrypoint2 Install stable version

Imports

entrypoint
```
from entrypoint2 import entrypoint
```

Quickstart

Define a function and decorate it with `@entrypoint`. The function's arguments become command-line parameters. You can then run the module as a script.

from entrypoint2 import entrypoint

@entrypoint
def hello(message):
    print(f"Hello, {message}!")

# To run from command line:
# python -m your_module_name hello World
# python -m your_module_name hello --help

view raw JSON →