Metadata-Version: 2.4
Name: cornflow-client-pchtsp
Version: 1.3.0
Summary: Client to connect to a cornflow server [forked from baobabsoluciones]
Author-email: Franco Peschiera <pchtsp@gmail.com>
Maintainer-email: Franco Peschiera <pchtsp@gmail.com>
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Operating System :: OS Independent
Classifier: Development Status :: 5 - Production/Stable
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE
Requires-Dist: requests
Requires-Dist: genson
Requires-Dist: jsonschema
Requires-Dist: marshmallow
Requires-Dist: pytups
Requires-Dist: ortools
Requires-Dist: pulp
Provides-Extra: excel
Requires-Dist: openpyxl; extra == "excel"
Requires-Dist: pandas; extra == "excel"
Dynamic: license-file

cornflow client
================

The aim of this repository is to have a client to use to connect to a deployed cornflow webserver

Requirements
~~~~~~~~~~~~

* python >= 3.8

Install cornflow-client
~~~~~~~~~~~~~~~~~~~~~~~~

To install the package do::

    python3 -m pip install cornflow-client

Use cornflow-client
~~~~~~~~~~~~~~~~~~~~

To use, first you have to import the package::

    from cornflow_client import CornFlow

Then you have to start up the client and login or sing up::

    client = CornFlow(url="URL_TO_THE_WEB_SERVER")
    client.sign_up(username, email, password)
    client.login(username, password)

And then finally you can use the cornflow webserver and start solving problems::

    instance_id = client.create_instance(data)
    execution_id = client.create_execution(instance_id, execution_config)
    status = client.get_status(execution_id)
    results = client.get_results(execution_id)
