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)
Raw data
{
"_id": null,
"home_page": "https://github.com/baobabsoluciones/cornflow",
"name": "cornflow-client",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": null,
"keywords": null,
"author": "baobab soluciones",
"author_email": "sistemas@baobabsoluciones.es",
"download_url": "https://files.pythonhosted.org/packages/66/90/5977ec37cc45d56f7d24eefb0d41046552eb6d37da0d9f1ca911dcf2e659/cornflow_client-1.1.5.tar.gz",
"platform": null,
"description": "Cornflow client\n================\n\nThe aim of this repository is to have a client to use to connect to a deployed cornflow webserver\n\nRequirements\n~~~~~~~~~~~~\n\n* python >= 3.8\n\nInstall cornflow-client\n~~~~~~~~~~~~~~~~~~~~~~~~\n\nTo install the package do::\n\n python3 -m pip install cornflow-client\n\nUse cornflow-client\n~~~~~~~~~~~~~~~~~~~~\n\nTo use, first you have to import the package::\n\n from cornflow_client import CornFlow\n\nThen you have to start up the client and login or sing up::\n\n client = CornFlow(url=\"URL_TO_THE_WEB_SERVER\")\n client.sign_up(username, email, password)\n client.login(username, password)\n\nAnd then finally you can use the cornflow webserver and start solving problems::\n\n instance_id = client.create_instance(data)\n execution_id = client.create_execution(instance_id, execution_config)\n status = client.get_status(execution_id)\n results = client.get_results(execution_id)\n",
"bugtrack_url": null,
"license": null,
"summary": "Client to connect to a cornflow server",
"version": "1.1.5",
"project_urls": {
"Homepage": "https://github.com/baobabsoluciones/cornflow"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "da152cb6a4d3c58c2064c5bff1af959873d406e3508eea71ccafb174ef0e857b",
"md5": "c22e801291e0cec67ecc1d6810f8567b",
"sha256": "2623505123db9300b6425c2d864ed666bd33e085b81a2d13f91ad170d8cb4cee"
},
"downloads": -1,
"filename": "cornflow_client-1.1.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "c22e801291e0cec67ecc1d6810f8567b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 127465,
"upload_time": "2025-01-15T08:01:16",
"upload_time_iso_8601": "2025-01-15T08:01:16.710157Z",
"url": "https://files.pythonhosted.org/packages/da/15/2cb6a4d3c58c2064c5bff1af959873d406e3508eea71ccafb174ef0e857b/cornflow_client-1.1.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "66905977ec37cc45d56f7d24eefb0d41046552eb6d37da0d9f1ca911dcf2e659",
"md5": "7922609ce31b9babfb5f6da8994d032d",
"sha256": "32b10f1dd4ae8b4d8d3be0e57b8c8bfac6fb1fde65c70d698725df394cdb3c59"
},
"downloads": -1,
"filename": "cornflow_client-1.1.5.tar.gz",
"has_sig": false,
"md5_digest": "7922609ce31b9babfb5f6da8994d032d",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 95525,
"upload_time": "2025-01-15T08:01:19",
"upload_time_iso_8601": "2025-01-15T08:01:19.194107Z",
"url": "https://files.pythonhosted.org/packages/66/90/5977ec37cc45d56f7d24eefb0d41046552eb6d37da0d9f1ca911dcf2e659/cornflow_client-1.1.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2025-01-15 08:01:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "baobabsoluciones",
"github_project": "cornflow",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "cornflow-client"
}
JSON
