nlip-server 0.1.0

No project description provided

NLIP Server

Welcome to the NLIP Server! This project is a basic implementation of NLIP server side protocol.

This package provides a library that can easily be customized to create your own NLIP based Solution.

The package depends on the NLIP client package.

Installation

This project uses Poetry for dependency management. First, please install Poetry.

To set up the Python project, create a virtual environment using the following commands.

1. Create the virtual environment:

poetry env use python

2. Install the application dependencies

poetry install

Publishing the Package

To publish the package to PyPI, ensure that your changes are committed and then create a version tag. You can do this with the following commands:

git tag v0.1.0  # Replace with new version
git push origin v0.1.0

Defining a new Server Side Solution

To define a new solution, you need to provide two subclasses of the provided abstract classes: NLIPApplicaiton and NLIPSession.

These two classes are defined in module server

The main routine of the solution should call the start_server routine in module server to create an instance of the solution server-side application. start_server takes a subclass of NLIP_Application as an argument.