| Name | OpenSolve JSON |
| Version |
0.0.3
JSON |
| download |
| home_page | None |
| Summary | The Python client for the OpenSolve linear optimization solver service. |
| upload_time | 2024-08-28 14:43:23 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.11 |
| license | None |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# OpenSolve Python Client
A simple programmatic solution for interacting with the [OpenSolve](https://open-solve.com) linear optimization service. [Read the complete, official docs here](https://open-solve.com/docs).
## Use a virtual environment
For every new project, create a new virtual environment. Read about them [here](https://docs.python.org/3/library/venv.html).
```
$ mkdir myProject && cd myProject
$ python3 -m venv myenv
```
Once you've created the virtual environment, activate it before beginning work.
```
$ cd path/to/myProject
$ source myenv/bin/activate
```
Once activated, you'll want to install all necessary packages (like the OpenSolve client) for your project.
## Install
Install the python client with
```
(myenv) $ python3 -m pip install OpenSolve
```
The OpenSolve client only requires the [requests](https://requests.readthedocs.io/en/latest/) package. The minimum required version of Python is 3.7 (but the latest version of Python is always recommended).
## Using It
After [setting up your OpenSolve account](https://open-solve.com/docs), you'll be able to do a few cool things.
### Submit jobs
```
from OpenSolve import Client
import time
import os
# create a client object with your authentication details
c = Client.client('your_username', 'your_password')
# submit a simple job (default options, no warmstart solution)
response = c.submit_job('path/to/your/problemfile.lp')
```
### Check on a job
```
status = c.check_job()
```
### Pull the results of a completed job
```
results = c.pull_results()
```
### List current and past jobs
```
jobs = c.ls_jobs()
```
Get more details at the official [docs](https://open-solve.com/docs).
Raw data
{
"_id": null,
"home_page": null,
"name": "OpenSolve",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.11",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Greg Hauser <greg@open-solve.com>",
"download_url": "https://files.pythonhosted.org/packages/d2/73/fa99a90d1be5e291b98f6e0e0a017c12c8e63cdd95a5bb588e85bcd80a89/opensolve-0.0.3.tar.gz",
"platform": null,
"description": "# OpenSolve Python Client\n\nA simple programmatic solution for interacting with the [OpenSolve](https://open-solve.com) linear optimization service. [Read the complete, official docs here](https://open-solve.com/docs).\n\n## Use a virtual environment\n\nFor every new project, create a new virtual environment. Read about them [here](https://docs.python.org/3/library/venv.html).\n\n```\n$ mkdir myProject && cd myProject\n$ python3 -m venv myenv\n```\n\nOnce you've created the virtual environment, activate it before beginning work.\n\n```\n$ cd path/to/myProject\n$ source myenv/bin/activate\n```\n\nOnce activated, you'll want to install all necessary packages (like the OpenSolve client) for your project.\n\n## Install\n\nInstall the python client with \n\n```\n(myenv) $ python3 -m pip install OpenSolve\n```\n\nThe OpenSolve client only requires the [requests](https://requests.readthedocs.io/en/latest/) package. The minimum required version of Python is 3.7 (but the latest version of Python is always recommended).\n\n## Using It\n\nAfter [setting up your OpenSolve account](https://open-solve.com/docs), you'll be able to do a few cool things. \n\n### Submit jobs\n\n```\n\nfrom OpenSolve import Client\nimport time\nimport os \n\n\n# create a client object with your authentication details\nc = Client.client('your_username', 'your_password') \n\n\n# submit a simple job (default options, no warmstart solution)\nresponse = c.submit_job('path/to/your/problemfile.lp') \n\n```\n\n### Check on a job\n\n```\nstatus = c.check_job()\n```\n\n### Pull the results of a completed job\n\n``` \nresults = c.pull_results()\n```\n\n### List current and past jobs\n\n```\njobs = c.ls_jobs()\n```\n\n\nGet more details at the official [docs](https://open-solve.com/docs).",
"bugtrack_url": null,
"license": null,
"summary": "The Python client for the OpenSolve linear optimization solver service.",
"version": "0.0.3",
"project_urls": {
"Homepage": "https://open-solve.com",
"Issues": "https://github.com/greg-open-solve/OpenSolveClient"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2dfae293d6d9416c0a6a01e25987bd5d5c662edb7302e5741734b776887e41dd",
"md5": "7d6103492ce39a403e0c08aa009f289b",
"sha256": "71990aa04379f6c5d9ee85a50979318397a3bd5e51f0ee7074ed27776328ac78"
},
"downloads": -1,
"filename": "opensolve-0.0.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7d6103492ce39a403e0c08aa009f289b",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.11",
"size": 22417,
"upload_time": "2024-08-28T14:43:22",
"upload_time_iso_8601": "2024-08-28T14:43:22.784951Z",
"url": "https://files.pythonhosted.org/packages/2d/fa/e293d6d9416c0a6a01e25987bd5d5c662edb7302e5741734b776887e41dd/opensolve-0.0.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "d273fa99a90d1be5e291b98f6e0e0a017c12c8e63cdd95a5bb588e85bcd80a89",
"md5": "048e53226ef8f00844b5fa56e29b7949",
"sha256": "68eaf8f32454dd9c5bfea8b23ddf95fd8494e76ef0a450a9164c730c7e051065"
},
"downloads": -1,
"filename": "opensolve-0.0.3.tar.gz",
"has_sig": false,
"md5_digest": "048e53226ef8f00844b5fa56e29b7949",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.11",
"size": 21723,
"upload_time": "2024-08-28T14:43:23",
"upload_time_iso_8601": "2024-08-28T14:43:23.749947Z",
"url": "https://files.pythonhosted.org/packages/d2/73/fa99a90d1be5e291b98f6e0e0a017c12c8e63cdd95a5bb588e85bcd80a89/opensolve-0.0.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-08-28 14:43:23",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "greg-open-solve",
"github_project": "OpenSolveClient",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "opensolve"
}
