https://github.com/kaltsoon/kilke-python-boilerplate

Python boilerplate code for communicating with Kilke
https://github.com/kaltsoon/kilke-python-boilerplate

Last synced: about 2 months ago
JSON representation

Python boilerplate code for communicating with Kilke

• Host: GitHub
• URL: https://github.com/kaltsoon/kilke-python-boilerplate
• Owner: Kaltsoon
• Created: 2019-06-09T11:51:05.000Z (over 5 years ago)
• Default Branch: master
• Last Pushed: 2020-11-07T10:50:43.000Z (about 4 years ago)
• Last Synced: 2023-04-06T05:12:19.821Z (almost 2 years ago)
• Language: Python
• Homepage:
• Size: 21.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# Python boilerplate for [kilke](https://github.com/Kaltsoon/kilke)

This repository contains boilerplate code, which can be used to establish basic communication with the kilke's `system-io` server.

## Installation

1. Install [Poetry](https://python-poetry.org/) by following the [installation instructions](https://python-poetry.org/docs/#installation).

2. Install dependencies by running `poetry install`

3. Create a file named `.env` into the project's root folder, and define values for `SYSTEM_ID` (id of the system you want to communicate with), `SYSTEM_IO_HOST` (`system-io` server host) and `SYSTEM_IO_PORT` (`system-io` server port) environment variables in the following manner:

```

SYSTEM_ID=

SYSTEM_IO_HOST=

SYSTEM_IO_PORT=

API_URL=

```

## Usage

Run `poetry run python3 src/index.py` to start the `index.py` script.