Core (harp)¶
The Core (harp
) package is the root namespace of the Harp framework.
It mostly contains a reference to the Config
class, because it’s the only object you need to start using Harp
using the python API (you don’t need to use this API, configuration files should be enough for most use cases, but
if you want to, this is the starting point).
For convenience, the run()
function is also available, which is a simple way to start the default server
implementation for your configuration object.
Example usage:
from harp import Config, run
config = Config()
config.add_defaults()
if __name__ == "__main__":
run(config)
You can find more information about how configuration works in the harp.config
module.
Contents¶
- run(builder)[source]¶
Run the default server using provided configuration.
- Parameters:
builder (_ConfigurationBuilder) – Config
- Returns:
Submodules¶
- ASGI (harp.asgi)
- Command Line (harp.commandline)
- Config (harp.config)
- Controllers (harp.controllers)
- Errors (harp.errors)
- Event Dispatcher (harp.event_dispatcher)
- HTTP (harp.http)
- Meta (harp.meta)
- Models (harp.models)
- harp.services
- Settings (harp.settings)
- Typing (harp.typing)
- Utils (harp.utils)
- Views (harp.views)