search

mbarkhau / bumpver

BumpVer: Automatic Versioning
https://github.com/mbarkhau/bumpver
MIT License
199 stars 36 forks source link

Python API Stability #202

Open salotz opened 1 year ago

salotz commented 1 year ago

I understand that bumpver is primarily a CLI tool, but I would like to try and use the Python API for scripting a more complex situation of bumping multiple versions in a monorepo.

Is there any guarantees on the internal API? Or maybe a weaker statement of it changes much etc. would help me evaluate this choice.

mbarkhau commented 1 year ago

No guarantees for API stability so far. If you're willing to write unit tests against the API you will be using, I think I can make a commitment regarding stability. So far the tests I've written are mostly end-to-end integration tests.

Perhaps you can start by sketching out which functions you'd be calling. I'd assume you'll be working with bumpver.v2version:incr and bumpver.v2rewrite:rewrite_files. You can look at usage of them in bumpver.cli.

petkostas commented 1 year ago

I have a similar situation in which I am planning to use bumpver. Thanks for the pointer @mbarkhau might make sense for the future to keep that in mind (API usage). And thanks for the lovely work!