Configurable command management for humans.
coma provides a modular and declarative interface for defining commands,
associated configuration files, and initialization routines. Configs and
initializations can be command-specific or injected as reusable components in
multiple commands.
from coma import command, wake
from dataclasses import dataclass
# Step 1: Declare one or more configurations.
@dataclass
class RemoteCfg:
server: str = "localhost"
port: int = 9001
# Step 2: Declare one or more commands.
@command
def push(remote: RemoteCfg, **data):
# Code for pushing data to remote. Mocked here as print statements.
print(f"Pushing data: {data}")
print(f"To url: {remote.server}:{remote.port}")
# Step 3: Launch!
if __name__ == "__main__":
wake()The declarations in the above example provide a rich command line interface for
invoking your program. Assuming this code is in a file called main.py, you get:
A command (push) that is invoked by name and command parameters (remote
and data) that are directly available as command line arguments (also by name):
$ python main.py push \
remote::server=127.0.0.1 remote::port=8000 \
data::header=foo data::content=bar
Pushing data: {'header': 'foo', 'content': 'bar'}
To url: 127.0.0.1:8000Configs that are automatically serialized to file based on their name (config remote
is saved to remote.yaml in this case), enabling long-term persistence:
$ ls
main.py
remote.yaml
$ cat remote.yaml
server: localhost
port: 9001Both YAML and JSON are supported!
Including:
- Removing the boilerplate of argparse
while retaining full
argparseinteroperability and customizability for complex use cases. - Providing a comprehensive set of hooks to easily tweak, replace, or extend
coma's template-based default behavior. - Integrating with omegaconf's extremely rich and powerful configuration management features.
pip install comaExcited? Jump straight into the extensive tutorials and examples of the official documentation.
From version 2.1.0:
- Significant design changes that break backwards compatibility:
- Removed
coma.register(). Everything happens via the@commanddecorator. - Folded all
coma.initiate()functionality intocoma.wake(). - Simplified all hook protocols and added new utilities for user-defined hooks.
- Removed
- Greatly improved command signature inspection:
- More robust parsing and invocation of command parameters.
- New
inlineconfig parameters!
From version 2.0.1:
- Changed
coma.wake()fromwarnings-based toException-based error handling.
From version 1.0.1:
- Add
@commanddecorator - Changed default prefix separator from
:to::to avoid conflict with dictionary notation - Minor improvements and bug fixes