Skip to content
This repository has been archived by the owner on Mar 11, 2024. It is now read-only.

Commit

Permalink
Update readme: package is deprecated
Browse files Browse the repository at this point in the history
  • Loading branch information
simonbowly authored and rluce committed Sep 22, 2023
1 parent 9e6eb48 commit 470ad99
Showing 1 changed file with 12 additions and 2 deletions.
14 changes: 12 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,25 @@
# gurobipy-stubs

**This package is no longer maintained. gurobipy versions 11.0 and later
will include type hints as part of the installation, so the stubs are no
longer needed.**

This package provides type hints for
[gurobipy](https://pypi.org/project/gurobipy/), the [Python API for
Gurobi](https://www.gurobi.com/documentation/9.1/refman/py_python_api_overview.html).
Gurobi](https://www.gurobi.com/documentation/10.0/refman/py_python_api_overview.html).
These stubs help you to write typed Python code, and enhance many IDE's
built-in auto completion features.

### Version Compatibility

- Version `1.0` of this package provides type hints for gurobipy `9.x`.
- Version `2.0` of this package provides type hints for gurobipy `10.x`.
- For later versions of gurobipy, you should not install this package.

### Example

With this type stubs package installed, static type checkers such as
[mypy](https://mypy.readthedocs.io/en/stable/index.html) willl be able to
[mypy](https://mypy.readthedocs.io/en/stable/index.html) will be able to
verify the types given in source code annotations like in this example:

```
Expand Down

0 comments on commit 470ad99

Please sign in to comment.