mformat 0.2__tar.gz

mformat-0.2/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: mformat
+Version: 0.2
+Summary: Uniform way to write simple text to different file formats
+Author: Tom Björkholm
+Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
+License-Expression: MIT
+Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/mformat
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pip
+Requires-Dist: setuptools
+Requires-Dist: build
+Requires-Dist: wheel
+Dynamic: author
+Dynamic: requires-dist
+Dynamic: requires-python
+
+# mformat
+
+The mformat package contains a number of classes providing a uniform way for a python program to write to a number of different file formats.
+
+The primary intended use is for text output from a python program, where the programmer would like the user to be able to select the output file formats. Some users may want the text as a Microsoft Word file, others as a LibreOffice Open Document Text file, while still others might want it as Markdown. By using the uniform way of writing provided by mformat the same python code can produce output in a number of different formats.
+
+This is intended to provide an easy and uniform way to produce information in different formats. The emphasis is on getting the same information into the different formats. This will allow you to get a correct (but perhaps rudimentary) document in several formats. If you want to produce the most estetically pleasing document in a particular format, this is not the correct library to use.
+
+## Installing mformat (base package, this package)
+
+The base package contains support for the output formats that are supported with a minimum of dependencies. Use this if you for some reason want to avoid extra dependencies.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat](https://pypi.org/project/mformat). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing base mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat
+````
+
+### Installing base mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat
+````
+
+## Installing mformat-ext (extended package)
+
+The extended package contains support also for output formats that require some additional dependencies. Use this if you want the full selection of output formats.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat-ext](https://pypi.org/project/mformat-ext). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing extended mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat-ext
+````
+
+### Installing extended mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat-ext
+````
+
+## What it does
+
+The main features supported in a uniform way for all supported output file formats are:
+
+* Factory function that takes file format and output file name as arguments
+* It opens and closes a file in the selected format, with protection against accidentically overwriting an existing file
+* The recommended way to use it is as a context manager in a with-clause, opening and closing the file
+* Headings (several levels)
+* Paragraphs
+* Nested bullet point lists
+* Nested numbered point lists
+* Mixed nested numbered point and bullet point lists
+* Tables
+* URLs in paragraphs, headings, numbered point list items and in bullet point list items
+
+## Design of program that uses mformat
+
+It is recommended that the ouput function(s) of the a Python program using mformat should have a with-clause getting the formatting object from the factory (easiest with `with create_mf(file_format=fmt, file_name=output_file_name) as`).
+In the context of the with-clause the programmer just calls a minimum of member functions:
+
+* `start_paragraph` to start a new paragraph with some provided text content.
+* `start_heading`to start a new heading with some provided text content.
+* `start_bullet_item` to start a new bullet point list item with some provided text content, and if needed to start the bullet point list with the bullet point item.
+* `start_numbered_point_item` to start a new numbered point list item with some provided text content, and if needed to start the numbered point list with the number point list item.
+* `add_text` to add more text to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `add_url` to add a URL (link) to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `start_table` to start a new table with the provided first row.
+* `add_table_row` to add another row to an already started table.
+* `write_complete_table` to write a table all at once.
+* `write_code_block` to write some preformatted text as a code block
+
+There are no member functions to end or close any document item. Each document item is automatically closed as another docuemnt item is started (or when closing the file at the end of the context manager scope). `start_bullet_item`and `start_numbered_point_item` take an optional level argument, that is used to change to another nesting level.
+
+## Example programs
+
+A number of minimal but complete example programs are provided to help the programmer new to mformat. See [list of examples](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md).
+
+## API documentation
+
+API documentation automatically extracted from the Python code and docstrings are available [here for the public API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/api.md) for programmers using the API and [here for the protected API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/protected_api.md) for programmers that want to extend the API by adding their own derived class that provide some other output format.
+
+Even though some may like reading API documentation, the [example programs](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md) probably provide a better introduction.
+
+## Version history
+
+| Version | Date        | Python version  | Description                         |
+|---------|-------------|-----------------|-------------------------------------|
+| 0.2     | 30 Jan 2026 | 3.12 or newer   | First released version              |
+
+## Output file formats
+
+The following table provides information about in which version support for a format was introduced.
+
+| Format | Full name of format | Which package | Starting at version |
+|--------|---------------------|---------------|---------------------|
+| docx   | Microsoft Word      | mformat-ext   | 0.2                 |
+| html   | Web page            | mformat       | 0.2                 |
+| md     | Markdown            | mformat       | 0.2                 |
+| odt    | Open Document Text  | mformat-ext   | 0.2                 |
+
+## Test summary
+
+* Test result: 916 passed in 10s
+* No Flake8 warnings.
+* No mypy errors found.
+* 0.2 built and tested using python version: Python 3.14.2

mformat-0.2/README_pypi.md

@@ -0,0 +1,110 @@
+# mformat
+
+The mformat package contains a number of classes providing a uniform way for a python program to write to a number of different file formats.
+
+The primary intended use is for text output from a python program, where the programmer would like the user to be able to select the output file formats. Some users may want the text as a Microsoft Word file, others as a LibreOffice Open Document Text file, while still others might want it as Markdown. By using the uniform way of writing provided by mformat the same python code can produce output in a number of different formats.
+
+This is intended to provide an easy and uniform way to produce information in different formats. The emphasis is on getting the same information into the different formats. This will allow you to get a correct (but perhaps rudimentary) document in several formats. If you want to produce the most estetically pleasing document in a particular format, this is not the correct library to use.
+
+## Installing mformat (base package, this package)
+
+The base package contains support for the output formats that are supported with a minimum of dependencies. Use this if you for some reason want to avoid extra dependencies.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat](https://pypi.org/project/mformat). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing base mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat
+````
+
+### Installing base mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat
+````
+
+## Installing mformat-ext (extended package)
+
+The extended package contains support also for output formats that require some additional dependencies. Use this if you want the full selection of output formats.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat-ext](https://pypi.org/project/mformat-ext). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing extended mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat-ext
+````
+
+### Installing extended mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat-ext
+````
+
+## What it does
+
+The main features supported in a uniform way for all supported output file formats are:
+
+* Factory function that takes file format and output file name as arguments
+* It opens and closes a file in the selected format, with protection against accidentically overwriting an existing file
+* The recommended way to use it is as a context manager in a with-clause, opening and closing the file
+* Headings (several levels)
+* Paragraphs
+* Nested bullet point lists
+* Nested numbered point lists
+* Mixed nested numbered point and bullet point lists
+* Tables
+* URLs in paragraphs, headings, numbered point list items and in bullet point list items
+
+## Design of program that uses mformat
+
+It is recommended that the ouput function(s) of the a Python program using mformat should have a with-clause getting the formatting object from the factory (easiest with `with create_mf(file_format=fmt, file_name=output_file_name) as`).
+In the context of the with-clause the programmer just calls a minimum of member functions:
+
+* `start_paragraph` to start a new paragraph with some provided text content.
+* `start_heading`to start a new heading with some provided text content.
+* `start_bullet_item` to start a new bullet point list item with some provided text content, and if needed to start the bullet point list with the bullet point item.
+* `start_numbered_point_item` to start a new numbered point list item with some provided text content, and if needed to start the numbered point list with the number point list item.
+* `add_text` to add more text to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `add_url` to add a URL (link) to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `start_table` to start a new table with the provided first row.
+* `add_table_row` to add another row to an already started table.
+* `write_complete_table` to write a table all at once.
+* `write_code_block` to write some preformatted text as a code block
+
+There are no member functions to end or close any document item. Each document item is automatically closed as another docuemnt item is started (or when closing the file at the end of the context manager scope). `start_bullet_item`and `start_numbered_point_item` take an optional level argument, that is used to change to another nesting level.
+
+## Example programs
+
+A number of minimal but complete example programs are provided to help the programmer new to mformat. See [list of examples](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md).
+
+## API documentation
+
+API documentation automatically extracted from the Python code and docstrings are available [here for the public API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/api.md) for programmers using the API and [here for the protected API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/protected_api.md) for programmers that want to extend the API by adding their own derived class that provide some other output format.
+
+Even though some may like reading API documentation, the [example programs](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md) probably provide a better introduction.
+
+## Version history
+
+| Version | Date        | Python version  | Description                         |
+|---------|-------------|-----------------|-------------------------------------|
+| 0.2     | 30 Jan 2026 | 3.12 or newer   | First released version              |
+
+## Output file formats
+
+The following table provides information about in which version support for a format was introduced.
+
+| Format | Full name of format | Which package | Starting at version |
+|--------|---------------------|---------------|---------------------|
+| docx   | Microsoft Word      | mformat-ext   | 0.2                 |
+| html   | Web page            | mformat       | 0.2                 |
+| md     | Markdown            | mformat       | 0.2                 |
+| odt    | Open Document Text  | mformat-ext   | 0.2                 |
+
+## Test summary
+
+* Test result: 916 passed in 10s
+* No Flake8 warnings.
+* No mypy errors found.
+* 0.2 built and tested using python version: Python 3.14.2

mformat-0.2/mformat.egg-info/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.4
+Name: mformat
+Version: 0.2
+Summary: Uniform way to write simple text to different file formats
+Author: Tom Björkholm
+Author-email: Tom Björkholm <klausuler_linnet0q@icloud.com>
+License-Expression: MIT
+Project-URL: Source code, https://bitbucket.org/tom-bjorkholm/mformat
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: pip
+Requires-Dist: setuptools
+Requires-Dist: build
+Requires-Dist: wheel
+Dynamic: author
+Dynamic: requires-dist
+Dynamic: requires-python
+
+# mformat
+
+The mformat package contains a number of classes providing a uniform way for a python program to write to a number of different file formats.
+
+The primary intended use is for text output from a python program, where the programmer would like the user to be able to select the output file formats. Some users may want the text as a Microsoft Word file, others as a LibreOffice Open Document Text file, while still others might want it as Markdown. By using the uniform way of writing provided by mformat the same python code can produce output in a number of different formats.
+
+This is intended to provide an easy and uniform way to produce information in different formats. The emphasis is on getting the same information into the different formats. This will allow you to get a correct (but perhaps rudimentary) document in several formats. If you want to produce the most estetically pleasing document in a particular format, this is not the correct library to use.
+
+## Installing mformat (base package, this package)
+
+The base package contains support for the output formats that are supported with a minimum of dependencies. Use this if you for some reason want to avoid extra dependencies.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat](https://pypi.org/project/mformat). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing base mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat
+````
+
+### Installing base mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat
+````
+
+## Installing mformat-ext (extended package)
+
+The extended package contains support also for output formats that require some additional dependencies. Use this if you want the full selection of output formats.
+
+If you want to use it, install it using pip from [https://pypi.org/project/mformat-ext](https://pypi.org/project/mformat-ext). There is no need to download anything from Bitbucket to write Python programs that use the library.
+
+### Installing extended mformat on mac and Linux
+
+````sh
+pip3 install --upgrade mformat-ext
+````
+
+### Installing extended mformat on Microsoft Windows
+
+````sh
+pip install --upgrade mformat-ext
+````
+
+## What it does
+
+The main features supported in a uniform way for all supported output file formats are:
+
+* Factory function that takes file format and output file name as arguments
+* It opens and closes a file in the selected format, with protection against accidentically overwriting an existing file
+* The recommended way to use it is as a context manager in a with-clause, opening and closing the file
+* Headings (several levels)
+* Paragraphs
+* Nested bullet point lists
+* Nested numbered point lists
+* Mixed nested numbered point and bullet point lists
+* Tables
+* URLs in paragraphs, headings, numbered point list items and in bullet point list items
+
+## Design of program that uses mformat
+
+It is recommended that the ouput function(s) of the a Python program using mformat should have a with-clause getting the formatting object from the factory (easiest with `with create_mf(file_format=fmt, file_name=output_file_name) as`).
+In the context of the with-clause the programmer just calls a minimum of member functions:
+
+* `start_paragraph` to start a new paragraph with some provided text content.
+* `start_heading`to start a new heading with some provided text content.
+* `start_bullet_item` to start a new bullet point list item with some provided text content, and if needed to start the bullet point list with the bullet point item.
+* `start_numbered_point_item` to start a new numbered point list item with some provided text content, and if needed to start the numbered point list with the number point list item.
+* `add_text` to add more text to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `add_url` to add a URL (link) to an already started paragraph, heading, bullet point list item or numbered point list item.
+* `start_table` to start a new table with the provided first row.
+* `add_table_row` to add another row to an already started table.
+* `write_complete_table` to write a table all at once.
+* `write_code_block` to write some preformatted text as a code block
+
+There are no member functions to end or close any document item. Each document item is automatically closed as another docuemnt item is started (or when closing the file at the end of the context manager scope). `start_bullet_item`and `start_numbered_point_item` take an optional level argument, that is used to change to another nesting level.
+
+## Example programs
+
+A number of minimal but complete example programs are provided to help the programmer new to mformat. See [list of examples](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md).
+
+## API documentation
+
+API documentation automatically extracted from the Python code and docstrings are available [here for the public API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/api.md) for programmers using the API and [here for the protected API](https://bitbucket.org/tom-bjorkholm/mformat/src/master/doc/protected_api.md) for programmers that want to extend the API by adding their own derived class that provide some other output format.
+
+Even though some may like reading API documentation, the [example programs](https://bitbucket.org/tom-bjorkholm/mformat/src/master/example/README.md) probably provide a better introduction.
+
+## Version history
+
+| Version | Date        | Python version  | Description                         |
+|---------|-------------|-----------------|-------------------------------------|
+| 0.2     | 30 Jan 2026 | 3.12 or newer   | First released version              |
+
+## Output file formats
+
+The following table provides information about in which version support for a format was introduced.
+
+| Format | Full name of format | Which package | Starting at version |
+|--------|---------------------|---------------|---------------------|
+| docx   | Microsoft Word      | mformat-ext   | 0.2                 |
+| html   | Web page            | mformat       | 0.2                 |
+| md     | Markdown            | mformat       | 0.2                 |
+| odt    | Open Document Text  | mformat-ext   | 0.2                 |
+
+## Test summary
+
+* Test result: 916 passed in 10s
+* No Flake8 warnings.
+* No mypy errors found.
+* 0.2 built and tested using python version: Python 3.14.2

mformat-0.2/mformat.egg-info/SOURCES.txt

@@ -0,0 +1,18 @@
+README_pypi.md
+pyproject.toml
+setup.py
+mformat.egg-info/PKG-INFO
+mformat.egg-info/SOURCES.txt
+mformat.egg-info/dependency_links.txt
+mformat.egg-info/requires.txt
+mformat.egg-info/top_level.txt
+src/mformat/__init__.py
+src/mformat/factory.py
+src/mformat/mformat.py
+src/mformat/mformat_html.py
+src/mformat/mformat_lists_impl.py
+src/mformat/mformat_md.py
+src/mformat/mformat_state.py
+src/mformat/mformat_textbased.py
+src/mformat/py.typed
+src/mformat/reg_pkg_formats.py

mformat-0.2/mformat.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

mformat-0.2/mformat.egg-info/requires.txt

@@ -0,0 +1,4 @@
+pip
+setuptools
+build
+wheel

mformat-0.2/mformat.egg-info/top_level.txt

@@ -0,0 +1 @@
+mformat

mformat-0.2/pyproject.toml

@@ -0,0 +1,22 @@
+[build-system]
+requires = ["setuptools"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "mformat"
+version = "0.2"
+authors = [
+  { name="Tom Björkholm", email="klausuler_linnet0q@icloud.com" },
+]
+description = "Uniform way to write simple text to different file formats"
+readme = "README_pypi.md"
+requires-python = ">=3.12"
+license = "MIT"
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+]
+dynamic = ["dependencies"]
+
+[project.urls]
+"Source code" = "https://bitbucket.org/tom-bjorkholm/mformat"

mformat-0.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

mformat-0.2/setup.py

@@ -0,0 +1,22 @@
+#! /usr/local/bin/python3
+"""Setup file specifying build of .whl."""
+
+from setuptools import setup
+
+setup(
+  name='mformat',
+  version='0.2',
+  description='Uniform way to write simple text to different file formats',
+  author='Tom Björkholm',
+  author_email='klausuler_linnet0q@icloud.com',
+  python_requires='>=3.12',
+  packages=['mformat'],
+  package_dir={'mformat': 'src/mformat'},
+  package_data={'mformat': ['src/py.typed']},
+  install_requires=[  # pylint: disable=duplicate-code
+    'pip',
+    'setuptools',
+    'build',
+    'wheel'
+  ]
+)

mformat-0.2/src/mformat/__init__.py

@@ -0,0 +1,6 @@
+#! /usr/local/bin/python3
+"""Initialize the mformat package."""
+
+# Copyright (c) 2025 - 2026 Tom Björkholm
+# MIT License
+#

mformat-0.2/src/mformat/factory.py

@@ -0,0 +1,185 @@
+#! /usr/local/bin/python3
+"""Factory class for creating MultiFormat instances."""
+
+# Copyright (c) 2025 - 2026 Tom Björkholm
+# MIT License
+#
+
+from typing import Optional, TypedDict, Callable
+from mformat.mformat import MultiFormat, FormatterDescriptor
+from mformat.reg_pkg_formats import register_formats_in_pkg
+
+
+_the_factory: Optional['MultiFormatFactory'] = None  # pylint: disable=invalid-name # noqa: E501
+
+
+class OptArgsDict(TypedDict, total=False):
+    """Optional arguments for the MultiFormat constructor."""
+
+    file_exists_callback: Optional[Callable[[str], None]]
+    lang: Optional[str]
+    title: Optional[str]
+    css_file: Optional[str]
+
+
+type OptArgs = Optional[OptArgsDict]
+
+
+class MultiFormatFactory:
+    """Factory class for creating instances of MultiFormat subclasses."""
+
+    def __init__(self) -> None:
+        """Initialize the factory with an empty registry."""
+        self._registry: dict[str, type[MultiFormat]] = {}
+        self._usage: dict[str, FormatterDescriptor] = {}
+        formats: list[type[MultiFormat]] = register_formats_in_pkg()
+        for format_class in formats:
+            self.i_register(format_class)
+
+    @staticmethod
+    def i_get_factory() -> 'MultiFormatFactory':
+        """Internally get the factory instance."""
+        global _the_factory  # pylint: disable=global-statement # noqa: E501
+        if _the_factory is None:
+            _the_factory = MultiFormatFactory()
+        return _the_factory
+
+    @staticmethod
+    def register(format_class: type[MultiFormat]) -> None:
+        """Register a MultiFormat subclass with the factory."""
+        factory = MultiFormatFactory.i_get_factory()
+        factory.i_register(format_class=format_class)
+
+    def i_register(self, format_class: type[MultiFormat]) -> None:
+        """Internally register a MultiFormat subclass with the factory."""
+        if not issubclass(format_class, MultiFormat):
+            err = f'{format_class.__name__} must be a subclass of MultiFormat'
+            raise ValueError(err)
+        desc: FormatterDescriptor = format_class.get_arg_desciption()
+        self._registry[desc.name] = format_class
+        self._usage[desc.name] = desc
+
+    @staticmethod
+    def create(format_name: str, file_name: str,
+               url_as_text: bool = False,
+               args: OptArgs = None) -> MultiFormat:
+        """Create an instance of a registered MultiFormat subclass.
+
+        Args:
+            format_name: The name identifier of the format class to create.
+            file_name: The file path to pass to the MultiFormat constructor.
+            url_as_text: Format URLs as text not clickable URLs.
+            args: additional arguments to pass to the MultiFormat constructor.
+        Returns:
+            An instance of the requested MultiFormat subclass.
+            Intended to be used as context manager, using a with statement.
+        Raises:
+            ValueError: If the format_name is not registered.
+        """
+        factory = MultiFormatFactory.i_get_factory()
+        return factory.i_create(format_name=format_name,
+                                file_name=file_name,
+                                url_as_text=url_as_text,
+                                args=args)
+
+    def i_create(self, format_name: str, file_name: str,
+                 url_as_text: bool = False,
+                 args: OptArgs = None) -> MultiFormat:
+        """Internally create an instance of a registered subclass."""
+        if format_name not in self._registry:
+            raise ValueError(
+                f'Format "{format_name}" is not registered. ' +
+                'Available formats: ' +
+                f'{", ".join(sorted(list(self._registry.keys())))}'
+            )
+        format_class = self._registry[format_name]
+        if args is None:
+            return format_class(file_name=file_name, url_as_text=url_as_text)
+        assert args is not None
+        return format_class(file_name=file_name,  # type: ignore[misc]
+                            url_as_text=url_as_text, **args)
+        # mypy cannot see which MultiFormat subclass is being created, so it
+        # cannot know which arguments are valid.
+
+    @staticmethod
+    def get_registered_formats() -> list[str]:
+        """Get a list of all registered format names.
+
+        Returns:
+            A list of registered format name strings.
+        """
+        factory = MultiFormatFactory.i_get_factory()
+        return factory.i_get_registered_formats()
+
+    def i_get_registered_formats(self) -> list[str]:
+        """Internally get a list of registered format names."""
+        return sorted(list(self._registry.keys()))
+
+    @staticmethod
+    def get_usage(format_name: str) -> FormatterDescriptor:
+        """Get the usage information for a registered format."""
+        factory = MultiFormatFactory.i_get_factory()
+        return factory.i_get_usage(format_name=format_name)
+
+    def i_get_usage(self, format_name: str) -> FormatterDescriptor:
+        """Internally get the usage information for a registered format."""
+        if format_name not in self._usage:
+            raise ValueError(
+                f'Format "{format_name}" is not registered. ' +
+                'Available formats: ' +
+                f'{", ".join(sorted(list(self._registry.keys())))}'
+            )
+        return self._usage[format_name]
+
+
+def create_mf(format_name: str, file_name: str,
+              url_as_text: bool = False,
+              args: OptArgs = None) -> MultiFormat:
+    """Create an instance of a registered MultiFormat subclass.
+
+    Intended to be used as context manager, using a with statement.
+    This is a shortcut for MultiFormatFactory.create().
+    Args:
+        format_name: The name identifier of the format class to create.
+        file_name: The file path to pass to the MultiFormat constructor.
+        url_as_text: Format URLs as text not clickable URLs.
+        args: additional arguments to pass to the MultiFormat constructor.
+    Returns:
+        An instance of the requested MultiFormat subclass.
+    Raises:
+        ValueError: If the format_name is not registered.
+    """
+    return MultiFormatFactory.create(format_name=format_name,
+                                     file_name=file_name,
+                                     url_as_text=url_as_text,
+                                     args=args)
+
+
+def list_registered_mf() -> list[str]:
+    """Get a list of all registered format names.
+
+    This is a shortcut for MultiFormatFactory.get_registered_formats().
+    Returns:
+        A list of registered format name strings.
+    """
+    return MultiFormatFactory.get_registered_formats()
+
+
+def usage_mf(format_name: str) -> FormatterDescriptor:
+    """Get the usage information for a registered format.
+
+    This is a shortcut for MultiFormatFactory.get_usage().
+    """
+    return MultiFormatFactory.get_usage(format_name=format_name)
+
+
+def register_mf(format_class: type[MultiFormat]) -> None:
+    """Register a MultiFormat subclass with the factory.
+
+    This is a shortcut for MultiFormatFactory.register().
+    Args:
+        format_class: The MultiFormat subclass to register.
+    Raises:
+        ValueError: If the format_class is not a subclass of MultiFormat.
+    """
+    MultiFormatFactory.register(format_class=format_class)