kore/pyko/README.md

52 lines
989 B
Markdown
Raw Blame History

This file contains invisible Unicode characters

This file contains invisible Unicode characters that are indistinguishable to humans but may be processed differently by a computer. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

About
-----
Pyko is a single binary kore build aimed at starting kore python applications
in a more easy and straight forward manner.
Building
--------
This kore application builds with PYTHON=1 and PGSQL=1 automatically.
See the kore README file on what dependencies are required for this.
From the root kore directory run:
```
$ make -C kodev
$ make -C pyko
$ sudo make -C pyko install
```
App layout
----------
Your python application directory must have the following layout:
```
python_app/
kore.conf <- actual kore configuration
__init__.py <- module initialization (binds, worker setup)
handlers.py <- handler code
```
You can easily use the kodev tool from kore to create an application
skeleton that gets you going:
```
$ kodev create -p myapp
$ cd myapp
$ pyko -frn
```
Usage
-----
```
$ pyko -frn python_app
```
```
-f = foreground
-n = skip chroot
-r = skip privilege drop
```
You can run pyko from inside the module directory directly as well.