Skip to content

Latest commit

 

History

History
58 lines (35 loc) · 2.37 KB

README.md

File metadata and controls

58 lines (35 loc) · 2.37 KB

Konviktion

codecov PyPI version Maintenance Maintainer PyPI pyversions PyPI status PyPI download month Code style: black Checked with mypy Ruff

Description

Konviktion is a simple, lightweight, notion gateway. It is designed to be used within the Arkitekt Framework to allow users to easily add pages to their notion workspace.

This is the client library for Konviktion, wich can be found here. More information will be added soon.

Requirements

Konviktion standalone requires that you have docker installed on your machine. If you do not have docker installed, you can find instructions for installing it here. Also we require you to have at least Python3.9.

pip install konviktion

Usage

While you can use docker to spin up a konviktion-server yourself, you can also use the deployed context manager to spin up a local konviktion-server.

from konviktion import deployed 
from konviktion.api.schema import create_github_repository

with deployed():

    

    

In the above example, we use the deployed context manager to spin up a a local konviktion-server, and are creating a repo on github. Repositories are online collections of various Apps (in various releases and flaovurs), that can be used to deploy containers running these apps.

More info to come soon. Stay tuned.