Skip to content

Commit 0cd51e1

Browse files
committed
Add backwards compatibility section to README
Added documentation about the inclusion of the legacy v1.1.5 API under the v1 subpackage, instructions for importing, and notes on dependency management for users requiring backward compatibility.
1 parent 8e1b606 commit 0cd51e1

1 file changed

Lines changed: 6 additions & 0 deletions

File tree

README.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -118,6 +118,12 @@ Explore all the features of **PyEnzyme** in our [documentation](https://pyenzyme
118118
and take part in [Discussions](https://github.com/EnzymeML/PyEnzyme/discussions)
119119
and/or [Issues](https://github.com/EnzymeML/PyEnzyme/issues).
120120

121+
## 🔙 Backwards compatibility
122+
123+
For backward compatibility with previous versions of PyEnzyme, this release includes the original `v1.1.5` version of the package under the `v1` subpackage. Users may continue to utilize the legacy API by importing from `pyenzyme.v1` instead of `pyenzyme`. Please be aware that the dependencies for the current `v2` implementation differ from those of `v1` and must be installed separately using `poetry install --with v1`.
124+
125+
For new projects, we recommend utilizing the updated API available in the package root. Existing users of the legacy API are encouraged to migrate to the current version to benefit from the latest features and improvements.
126+
121127
## 🧪 Testing
122128

123129
In order to run tests there are two different ways. First you can utilize `pytest` directly by running the following:

0 commit comments

Comments
 (0)