Metadata-Version: 2.1
Name: kgrid-python-runtime
Version: 0.0.3
Summary: A runtime for python-based Knowledge Objects
Home-page: https://github.com/kgrid/kgrid-python-runtime
Author: Kgrid Developers
Author-email: kgrid-developers@umich.edu
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Framework :: Flask
Classifier: Natural Language :: English
Classifier: Topic :: Scientific/Engineering :: Medical Science Apps.
Requires-Python: >=3.8
Description-Content-Type: text/markdown

# kgrid-python-runtime
KGrid runtime for Knowledge Objects in python

Getting started:
- Install [Python 3.8](https://www.python.org/downloads/) or higher
- Install pip
- Download Kgrid Python Runtime from github
- Navigate to the folder containing `app.py`
- In a terminal, install the required dependencies with:

    `pip install -r requirements.txt`
- To start the Python runtime:

    `python kgrid_python_runtime/app.py runserver`

- The runtime starts on port 5000, but can be specified with `KGRID_PYTHON_ENV_URL`
- By default, the python runtime points to a Kgrid activator at url: 
    `http://localhost:8080`

    This can be customized by setting the environment variable:
    `KGRID_PROXY_ADAPTER_URL`
- By default, the python runtime will tell the Kgrid Activator that it is started at `http://localhost:5000`.

    If you're starting the runtime at a different address, that url must be specified by setting the environment variable:
    `KGRID_PYTHON_ENV_URL`


