pluggable-namespace 2.2.1

Installation

You can install pluggable-namespace from PyPI:

pip3 install pluggable-namespace

Creating a pluggable application can be accomplished with just a few lines of code. The heart of every pluggable-namespace project is the creation of a hub, adding dynamic subsystems, and interacting with them through the hub’s namespace.

import pns.shim
import asyncio


async def main():
    hub = await pns.shim.loaded_hub()
    await hub.my_sub.init.cli()

if __name__ == "__main__":
    asyncio.run(main())

Configuration

When building a pluggable-namespace app, all configuration settings are stored in a config.yaml file.

# Each configuration option for your module
config:
  my_namespace:
    my_opt:
      default: True

# Options exposed on the CLI when your app controls the CLI
cli_config:
  my_namespace:
    my_opt:
      help: Description of this option
      subcommands:
        - my_subcommand
      group: My arg group

# Subcommands to expose for your project
subcommands:
  my_namespace:
    my_subcommand:
      help: My subcommand

# Dynamic namespaces that your app merges onto and which folders extend those namespaces
dyne:
  my_dyne:
    - src_dir

# Python imports that your app uses, to be added to hub.lib for your app
import:
  - asyncio
  - importlib
  - importlib.resources
  - os
  - toml

From the example above, all arguments are loaded onto the namespace under hub.OPT.my_namespace. One config.yaml can add configuration options to multiple namespaces. They are merged in the order found in sys.path.

Extending Namespaces

export PYTHONPATH=$PYTHONPATH:/path/to/project_root

# project_root/config.yaml
dyne:
  namespace:
    # This references the directory project_root/foo
    - foo

hub seed.init.cli /path/to/project_root name=my_project