Skip to content
This repository has been archived by the owner on Jul 17, 2023. It is now read-only.

Latest commit

 

History

History
38 lines (23 loc) · 1.62 KB

README.md

File metadata and controls

38 lines (23 loc) · 1.62 KB

Project no longer maintained

⚠️ To begin using Unikraft please refer to KraftKit which is the companion tool used for defining, configuring, building, and running Unikraft applications.
This project will be renamed to https://github.com/unikraft/pykraft.git on February 1st 2023.

pykraft: Python3 Bindings for Unikraft

The pykraft python library aids in building unikernels systematically. It requires the following dependencies (for Debian-based systems):

apt-get install -y --no-install-recommends build-essential libncurses-dev libyaml-dev flex git wget socat bison unzip uuid-runtime;

Note: Ubuntu 20.04 users may suffer from issue #29 due to this bug of socat-1.7.3.3. If you are using Ubuntu 20.04, please make sure to compile and install the latest version of socat retrieved from this page.

To install simply run:

pip3 install git+https://github.com/unikraft/kraft.git@staging

Building an Application

The simplest way to build a unikernel is to pass in an application directory to Application.from_workdir:

from kraft.app import Application

app = Application.from_workdir(workdir)

if not app.is_configured():
    app.configure()

app.fetch()
app.prepare()
app.build()

License

Pykraft is part of the Unikraft OSS Project and licensed under BSD-3-Clause.