API Definitions

Global Tools

API	Description
`base_dir`	The base Directory. Path to the project.
`mode`	Framework's current mode (`development`, `production`, `staging` and `custom`).
`config`	Core (Settings) `TOML` files are loaded here (`spoc.toml`, `pyproject.toml` and `{env}.toml`).
`config['env']`	Environment Variables `TOML` file `{env}.toml` Options (`development`, `production` , `staging`).
`settings`	Pythonic (Settings) are loaded here (`settings.py`).

Example:

spoc.settings

Key	Description	Variable(s)
`singleton`	Tool to create a Singleton Object.	`(object: class)`
`component`	Tool to create Component(s) for your Framework.	`(config: dict, metadata: dict)`
`is_component`	Tool to verify the Component(s) by adding metadata.	`(object: any, metadata: dict)`

Example:

spoc.is_component(hello_world, components["command"])

Key	Description	Variable(s)
`App`	The Framework.	`(plugins: list)`

Example:

spoc.App(plugins=["commands"])

Key	Description
`component`	The Components.
`extras`	The Internal Methods.