Metadata-Version: 2.4
Name: new-horizon
Version: 0.0.2
Summary: A Client Library for Interaction with Pluto.
Author-email: Philipp Kroll <pk@eample.com>
License: Copyright (c) 2018 The Python Packaging Authority
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Project-URL: Homepage, https://github.com/Philipp-Co/pluto
Project-URL: Issues, https://github.com/Philipp-Co/pluto/issues
Classifier: Programming Language :: Python :: 3
Classifier: Operating System :: OS Independent
Requires-Python: >=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: requests>=2.32.5
Requires-Dist: typing_extensions>=4.15.0
Dynamic: license-file

# Plyto

Plyto is a Framework for writing Event driven Applications.

# Prerequisits

Plyto is a Wrapper around a Set of binary Executables and shared Libraries.
You have to make sure, that these Executables and Libraries are installed properly before going of with Plyto.

# Setup

To Test Plyto you have to set your Project up first.
Create a virtual Environment with

    python -m venv .venv

and install the Requirements into this Environment

    source .venv/bin/activate && pip install -r requirements.txt

# Test

If you want to run Tests, execute this command

    python -m unittest discover test

# Build

Since you have run all the Tests you know Plyto is running correctly on your Machine.
Now you want to build a distributable Package which contain Plyto.

    python -m build --sdist

This will package Plyto and store it in the directory dist/plyto-x.y.z.tar.gz

# Useage

Plyto reads some Environment Variables which are

    PLUTO_WORKDIR
    PLUTO_BINARYDIR

If you want to customize Plytos behavior, assign your own values to these Variables.
For each Meaning of the Variables see the Sections bellow.

Copy the Packge to its destination and install this package using

    pip install plyto-x.y.z.tar.gz

## Environment Variable PLUTO_WORKDIR

This Variable defaults to '/tmp/pluto/workdir/'.
Pluto will store its Configuration Files in this Directory.

## Environment Variable PLUTO_BINARYDIR

This Variable defaults to '/usr/local/bin/'.
Pluto trys to find the binary Executables in this Directory.
