FICO<sup>®</sup> Xpress Insight Python Package
==================================================
The 'xpressinsight' Python package can be used to develop Python<sup>®</sup> based web applications for Xpress Insight.
Documentation
-------------
- [FICO Xpress Insight 4 Python Package Reference Manual](https://www.fico.com/fico-xpress-optimization/docs/latest/insight-python-doc)
- [FICO Xpress Insight 4 Developers Guide For Python](https://www.fico.com/fico-xpress-optimization/docs/latest/insight_dev_guide_py)
- [FICO Xpress Insight 5 Python Package Reference Manual](https://www.fico.com/fico-xpress-optimization/docs/latest/insight5-python-doc)
- [FICO Xpress Insight 5 Developers Guide For Python](https://www.fico.com/fico-xpress-optimization/docs/latest/insight5_dev_guide_py)
Release Notes
-------------
__v 1.7.1 (Insight 5.7.0)__
- New function `get_solution_database` returns the location and credentials of the DMP solution's database.
- Enabled functions `get_app_attach`, `get_scen_attach` and `put_scen_attach` to write/read the attachment to/from a
folder other than the work directory or a local filename different from attachment name.
- Enabled functions `get_attach_by_tag`, `get_attachs_by_tag` and `get_attach_filenames_by_tag` to write the
attachments to a folder other than the work directory.
- Fixed an issue with the `InsightDmpContext.solution_token_expiry_time` value in non-UTC timezones.
- Removed support for Python 3.7. This version supports only Python 3.8 - 3.11.
__v 1.6.0 (Insight 5.6.0)__
- Resolved an error when a script declares multiple app classes with a shared superclass.
- Added attribute `default` to the `xi.Column` class.
- Use of the old syntax for annotating entities (e.g. `xi.Scalar` instead of `xi.types.Scalar`) will cause a warning
message when the app is built or executed in Python 3.11. This syntax has been deprecated and will not be usable
at all in Python 3.12+.
- New function `get_insight_context` returns information about the Insight server and the DMP solution.
- Python 3.11 support.
- Pandas 2.0 support.
__v 1.5.0 (Insight 5.5.0)__
- Allow an Index entity to be referenced multiple times within a single Series or DataFrame -
e.g. `Distance: xi.types.Series(index=['City', 'City'], dtype=xi.real)`.
- Support `multiprocessing` package.
__v 1.4.1 (Insight 4.59.6)__
- Resolve issue building apps with Xpress 9.2 and apprunner 1.4.
- Update dependencies to require Pandas v1 with xpressinsight 1.4.
__v 1.4.0 (Insight 5.4.0 and 4.59.2)__
- New syntax for annotating entities, `xi.types.Scalar`/`Param`/`Index`/`Series`/`DataFrame` instead
of `xi.Scalar`/`Param`/`Index`/`Series`/`DataFrame`.
- The new syntax is compatible with forward annotations (`from __future__ import annotations`).
- The old syntax will continue to work in Python 3.7-3.10 but will not be usable in Python 3.11+,
so we recommend existing apps are migrated from the old to the new syntax.
- When the new syntax is used, entities may also be declared in a parent class of the Insight
application class.
__v 1.3.0__
- Support for Insight 5 custom progress notifications:
- Added functions `send_progress_update`, `get_messages` and `put_messages` to Insight application interface
(`AppInterface`).
- Added the `send_progress` attribute the `ExecMode`, `ExecModeLoad`, and `ExecModeRun` decorators.
- Added the `update_progress` attribute to the entity type annotations.
- RHEL 8 support.
- Python 3.10 support
- At time of writing the ‘default’ Anaconda channel does not have all the dependencies required by the
`xpressinsight` package for this Python version. We recommend conda users to stick with Python 3.9, or use a
different distribution of Python 3.10 until this is resolved.
- Fixed an issue that caused a failure if the path to the temporary directory contained a space.
__v 1.2.3__
- Added the `threads` attribute to the `ExecMode`, `ExecModeLoad`, and `ExecModeRun` decorators.
__v 1.2.2__
- Fixed an issue that could cause a type check exception when the user created
empty (null) fields in a DataFrame column in the Insight UI.
__v 1.2.1__
- Added test mode functions `add_item_info` and `clear_item_infos` to Insight application interface.
- Added function `scenario_parent_path` to Insight application interface.
- Added `RepositoryPath` class for building and parsing of repository paths.
__v 1.2.0__
- Added scenario types property (`scen_types`) to application configuration (`AppConfig`).
- Added repository functions `get_item_info` and `get_item_infos` to Insight application interface (`AppInterface`).
__v 1.1.3__
- Performance improvements.
- Python 3.9 support.
__v 1.1.2__
- Fixed an exception that could occur when an empty MultiIndex DataFrame has been assigned to an Insight entity.
- Updated documentation describing how to set up Anaconda.
__v 1.1.1__
- Improve error message when Insight cannot start Python because of security restrictions.
- Update documentation and update VDL version number in examples.
__v 1.1.0__
- Additional factory function `create_app` initializes and configures standard test environment.
- Some performance issues with executing a Python based scenario have been addressed.
- Maximum length of a string in an Index, Series, or DataFrame has been changed from 1,000,000 bytes to 250,000 characters.
- Default name of the temporary Insight working directory has been changed from "insight" to "work_dir/insight".
__v 1.0.2__
- The functions `update` and `reset_progress` have been added to the Insight Python interface.
- Changed Python standard output to unbuffered mode to improve responsiveness of output messages.
Licensing
---------
The Xpress software is governed by the
[Xpress Shrinkwrap License Agreement](https://community.fico.com/s/contentdocument/06980000002h0i5AAA).
When downloading or using the package, you accept the license terms. After installation, a copy of the Xpress Shrinkwrap
License will be stored in the `LICENSE.txt` file in the `site-packages/xpressinsight-*.dist-info` directory.
In Anaconda, a copy of the license file will be stored in the `pkgs/xpressinsight-*/info/licenses` directory.
"Python" is a registered trademark of the Python Software Foundation.
"FICO" is a registered trademark of Fair Isaac Corporation in the United States
and may be a registered trademark of Fair Isaac Corporation in other countries.
Other product and company names herein may be trademarks of their respective owners.
© Copyright 2012-2023 Fair Isaac Corporation. All rights reserved.
Raw data
{
"_id": null,
"home_page": "https://www.fico.com/en/products/fico-xpress-optimization-suite",
"name": "xpressinsight",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.8",
"maintainer_email": "",
"keywords": "optimization xpress insight",
"author": "FICO Xpress dev. team",
"author_email": "support@fico.com",
"download_url": "",
"platform": "any",
"description": "FICO<sup>®</sup> Xpress Insight Python Package\n==================================================\n\nThe 'xpressinsight' Python package can be used to develop Python<sup>®</sup> based web applications for Xpress Insight.\n\nDocumentation\n-------------\n\n- [FICO Xpress Insight 4 Python Package Reference Manual](https://www.fico.com/fico-xpress-optimization/docs/latest/insight-python-doc)\n- [FICO Xpress Insight 4 Developers Guide For Python](https://www.fico.com/fico-xpress-optimization/docs/latest/insight_dev_guide_py)\n- [FICO Xpress Insight 5 Python Package Reference Manual](https://www.fico.com/fico-xpress-optimization/docs/latest/insight5-python-doc)\n- [FICO Xpress Insight 5 Developers Guide For Python](https://www.fico.com/fico-xpress-optimization/docs/latest/insight5_dev_guide_py)\n\nRelease Notes\n-------------\n\n__v 1.7.1 (Insight 5.7.0)__\n\n- New function `get_solution_database` returns the location and credentials of the DMP solution's database.\n- Enabled functions `get_app_attach`, `get_scen_attach` and `put_scen_attach` to write/read the attachment to/from a \n folder other than the work directory or a local filename different from attachment name.\n- Enabled functions `get_attach_by_tag`, `get_attachs_by_tag` and `get_attach_filenames_by_tag` to write the\n attachments to a folder other than the work directory.\n- Fixed an issue with the `InsightDmpContext.solution_token_expiry_time` value in non-UTC timezones.\n- Removed support for Python 3.7. This version supports only Python 3.8 - 3.11.\n\n__v 1.6.0 (Insight 5.6.0)__\n\n- Resolved an error when a script declares multiple app classes with a shared superclass.\n- Added attribute `default` to the `xi.Column` class.\n- Use of the old syntax for annotating entities (e.g. `xi.Scalar` instead of `xi.types.Scalar`) will cause a warning\n message when the app is built or executed in Python 3.11. This syntax has been deprecated and will not be usable \n at all in Python 3.12+.\n- New function `get_insight_context` returns information about the Insight server and the DMP solution.\n- Python 3.11 support.\n- Pandas 2.0 support.\n\n__v 1.5.0 (Insight 5.5.0)__\n\n- Allow an Index entity to be referenced multiple times within a single Series or DataFrame - \n e.g. `Distance: xi.types.Series(index=['City', 'City'], dtype=xi.real)`.\n- Support `multiprocessing` package.\n\n__v 1.4.1 (Insight 4.59.6)__\n\n- Resolve issue building apps with Xpress 9.2 and apprunner 1.4.\n- Update dependencies to require Pandas v1 with xpressinsight 1.4.\n\n__v 1.4.0 (Insight 5.4.0 and 4.59.2)__\n\n- New syntax for annotating entities, `xi.types.Scalar`/`Param`/`Index`/`Series`/`DataFrame` instead\n of `xi.Scalar`/`Param`/`Index`/`Series`/`DataFrame`.\n - The new syntax is compatible with forward annotations (`from __future__ import annotations`).\n - The old syntax will continue to work in Python 3.7-3.10 but will not be usable in Python 3.11+, \n so we recommend existing apps are migrated from the old to the new syntax.\n - When the new syntax is used, entities may also be declared in a parent class of the Insight \n application class.\n\n__v 1.3.0__\n\n- Support for Insight 5 custom progress notifications:\n - Added functions `send_progress_update`, `get_messages` and `put_messages` to Insight application interface\n (`AppInterface`).\n - Added the `send_progress` attribute the `ExecMode`, `ExecModeLoad`, and `ExecModeRun` decorators.\n - Added the `update_progress` attribute to the entity type annotations.\n- RHEL 8 support.\n- Python 3.10 support\n - At time of writing the \u2018default\u2019 Anaconda channel does not have all the dependencies required by the \n `xpressinsight` package for this Python version. We recommend conda users to stick with Python 3.9, or use a \n different distribution of Python 3.10 until this is resolved.\n- Fixed an issue that caused a failure if the path to the temporary directory contained a space.\n\n__v 1.2.3__\n\n- Added the `threads` attribute to the `ExecMode`, `ExecModeLoad`, and `ExecModeRun` decorators.\n\n__v 1.2.2__\n\n- Fixed an issue that could cause a type check exception when the user created\n empty (null) fields in a DataFrame column in the Insight UI.\n\n__v 1.2.1__\n\n- Added test mode functions `add_item_info` and `clear_item_infos` to Insight application interface.\n- Added function `scenario_parent_path` to Insight application interface.\n- Added `RepositoryPath` class for building and parsing of repository paths.\n\n__v 1.2.0__\n\n- Added scenario types property (`scen_types`) to application configuration (`AppConfig`).\n- Added repository functions `get_item_info` and `get_item_infos` to Insight application interface (`AppInterface`).\n\n__v 1.1.3__\n\n- Performance improvements.\n- Python 3.9 support.\n\n__v 1.1.2__\n\n- Fixed an exception that could occur when an empty MultiIndex DataFrame has been assigned to an Insight entity.\n- Updated documentation describing how to set up Anaconda.\n\n__v 1.1.1__\n\n- Improve error message when Insight cannot start Python because of security restrictions.\n- Update documentation and update VDL version number in examples.\n\n__v 1.1.0__\n\n - Additional factory function `create_app` initializes and configures standard test environment.\n - Some performance issues with executing a Python based scenario have been addressed.\n - Maximum length of a string in an Index, Series, or DataFrame has been changed from 1,000,000 bytes to 250,000 characters.\n - Default name of the temporary Insight working directory has been changed from \"insight\" to \"work_dir/insight\".\n\n__v 1.0.2__\n\n - The functions `update` and `reset_progress` have been added to the Insight Python interface.\n - Changed Python standard output to unbuffered mode to improve responsiveness of output messages.\n \nLicensing\n---------\n\nThe Xpress software is governed by the\n[Xpress Shrinkwrap License Agreement](https://community.fico.com/s/contentdocument/06980000002h0i5AAA).\nWhen downloading or using the package, you accept the license terms. After installation, a copy of the Xpress Shrinkwrap \nLicense will be stored in the `LICENSE.txt` file in the `site-packages/xpressinsight-*.dist-info` directory.\nIn Anaconda, a copy of the license file will be stored in the `pkgs/xpressinsight-*/info/licenses` directory.\n\n\"Python\" is a registered trademark of the Python Software Foundation.\n\"FICO\" is a registered trademark of Fair Isaac Corporation in the United States \nand may be a registered trademark of Fair Isaac Corporation in other countries. \nOther product and company names herein may be trademarks of their respective owners.\n\n© Copyright 2012-2023 Fair Isaac Corporation. All rights reserved.\n",
"bugtrack_url": null,
"license": "Xpress Shrinkwrap License Agreement",
"summary": "FICO Xpress - Insight Python package",
"version": "1.7.1",
"project_urls": {
"Homepage": "https://www.fico.com/en/products/fico-xpress-optimization-suite"
},
"split_keywords": [
"optimization",
"xpress",
"insight"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bd6b1edac49259a66d5337662b3396e5f6cde1cedae0261ed741fe08b1bc069d",
"md5": "151315f2b8cd8eaa6febf6b25237ff3e",
"sha256": "4448ec868a1cbb1e8715f0d74d2ab86ca3130688f6e5315461b274443cc5482c"
},
"downloads": -1,
"filename": "xpressinsight-1.7.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "151315f2b8cd8eaa6febf6b25237ff3e",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 147831,
"upload_time": "2023-07-24T11:30:46",
"upload_time_iso_8601": "2023-07-24T11:30:46.941496Z",
"url": "https://files.pythonhosted.org/packages/bd/6b/1edac49259a66d5337662b3396e5f6cde1cedae0261ed741fe08b1bc069d/xpressinsight-1.7.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-24 11:30:46",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "xpressinsight"
}