Attention

This is the documentation for HARP Proxy, actually published as an early preview. Both the software and documentation are a work in progress, and although we already use it on various production servers, they may contain inaccuracies, typographical errors, huge mistakes and empty pages. We work hard to eradicate all mistakes and implement stuff, but it is a long and tedious process. We appreciate your patience and understanding. Of course, any help will be greatly appreciated.

Command Line (harp.commandline)

The Command Line (harp.commandline) package bundles everything related to the harp command.

It contains an entrypoint() callable, built using click, which is called when you type harp in your terminal.

It is a high-level development helper: for example, harp start wraps honcho, a python process manager (foreman clone) that can spawn multiple processes to help you with development.

Production environment will favour the lower-level bin/entrypoint script, that skips the process manager entirely and runs the application server directly.

This may be subject to changes in the future (especially to align/refactor arg parsers), but this approach works well for now.

Todo

@click.option(’–prod/–dev’, default=False, help=”Set defaults for production or development environment (default to dev).”)

@click.option(’–verbose’, ‘-v’, count=True) –verbose : change default log verbosity

@click.option(’–debug’, is_flag=True) –debug : ?

Manage process list / options using a class (with hierarchy for prod/dev, for example) If one process only, no honcho ? Or mayne no honcho manager ?

Todo

Possible future things (or not)

  • build (compile stuff for production)

  • serve (run a production-like server)

Document how harp start work (honcho, devserver port, …)

Submodules