Refactor to put API at the center

nedbat / scriv

Changelog management tool

https://scriv.readthedocs.io

Apache License 2.0

256 stars 28 forks source link

Refactor to put API at the center #28

Closed nedbat closed 3 years ago

nedbat commented 3 years ago

This is a work in progress.

The code has been refactored to produce a public API in the classes in scriv.py (Fragment, Changelog, and Scriv). The create and collect CLI commands use the API.

Some things that are not yet done:

Documentation. Even the docstrings are just single-line notes.
I'm not sure what to do about logging. The API doesn't log. Is that OK?
Checks for missing directories and overwriting existing fragments are in the CLI code, not the API. Is that right?

The big question of course: is this a useful API? Does it match your idea of what it should be shaped like?

webknjaz commented 3 years ago

This is a work in progress.

FYI GitHub has a feature of Draft PRs, it signals the status even better (that "Open" label on top would show up as "Draft")

brettcannon commented 3 years ago

@nedbat would you like any help with this PR to help push this API over the finish line?

nedbat commented 3 years ago

@brettcannon it's just a matter of where the item is in the priority list... Will you be using scriv?

brettcannon commented 3 years ago

I would like to use it for https://github.com/brettcannon/python-launcher. Having the API would let me generate the release notes per release on GitHub releases as well as the overall changelog. I don't know how much churn there will be on this project, though, in terms of being a "heavy" user of scriv.

But I do understand this being about priorities. If you are looking for a code review or something I'm happy to help out.

nedbat commented 3 years ago

I'll merge this and release it. Let me know if you use it, what needs to change.

nedbat commented 3 years ago

This is now released as 0.11.0.