Metadata-Version: 2.1
Name: frinx-python-sdk
Version: 2.3.0
Summary: Python SDK for Frinx Machine Workflow Manager
License: Apache 2.0
Keywords: frinx-machine,workflow-manager,conductor
Author: Jozef Volak
Author-email: jozef.volak@elisapolystar.com
Requires-Python: >=3.10,<4.0
Classifier: License :: Other/Proprietary License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: aiohttp (>=3.8.4,<4.0.0)
Requires-Dist: prometheus-client (>=0.20.0,<0.21.0)
Requires-Dist: pydantic (>=2.3,<2.6)
Requires-Dist: pydantic-settings (>=2.1.0,<3.0.0)
Requires-Dist: requests (>=2.28.2,<3.0.0)
Requires-Dist: websockets (>=12,<13)
Description-Content-Type: text/markdown

# Frinx Python SDK
This package contains implementation of [Workflow Manager](https://docs.frinx.io/frinx-workflow-manager/introduction/)
client, building blocks for task and workflow definitions and ready-to-use implementations of tasks and workflows,
which cover basic use cases of [FRINX MACHINE](https://docs.frinx.io/) components.

## Environment set up
1. Install poetry
    ```sh
    pip3 install poetry
    ```

2. Install dependencies
     ```sh
    poetry install
    ```

## How to contribute
1. Create new feature branch.
   ```sh
   git checkout -b <branch_name>
   ```

2. Add your changes.
   ```sh
   git add <file>
   ```

3. OPTIONAL - Run pre-commit. Pre-commit triggers linting and static type checker hooks. These checks are also
   triggered by GitHub actions when a PR is created or updated. All errors and warnings raised by linters and
   type checkers must be fixed before the PR can be merged.
   ```sh
   poetry shell
   pre-commit
   ```

4. Commit your changes. We do not enforce commit message structure, but you should follow these
   [best practices](https://cbea.ms/git-commit/).
   ```sh
   git commit
   ```

5. Push your branch to remote repository.
   ```sh
   git push -u origin <branch_name>
   ```

