dictation-toolbox / natlink

Natlink provides the interface between Dragon and python
Other
25 stars 17 forks source link

natlinkcore should be removed from natlink #119

Closed dougransom closed 2 years ago

dougransom commented 2 years ago

The more I work on natlinkcore, the more i think it should be in a seperate repository from natlink.

It seems unwieldy to have two packages (natlink and natlinkcore) which usually :

LexiconCode commented 2 years ago

I'm in very strong favor of this for many of the reasons mentioned above. One really important is clean commit history and documentation. Separating makes it much easier to tell what's going on with each project as they really are separate projects. The C++ COM module job is simply to expose Dragon interface to Python providing essentially Python bindings to Dragon for other projects to use. This is where NalinkCore picks up and leveraging those bindings and creating a grammar eco-system.

Separating packages from an end-user's perspective will be completely transparent.

From a developers perspective simply if you're working on C++ code this repository and if on Python NatlinkCore repository.

If we do move forward with this maybe we should actually wait on release as it won't take too long to separate the code and spin up another repository for NalinkCore.

That way the next release can be just for the C ++/installer and in another release NakinkCore in the new repository. That way we won't have this awkward mix between the two. In addition because NakinkCore Python package is new makes (unreleased in the repository not as a package) sense to make this separation now rather than later.

quintijn commented 2 years ago

OK, I take your opinions serious, so go ahead!

dougransom commented 2 years ago

@LexiconCode i am happy to do it once https://github.com/dictation-toolbox/natlink/pull/121 is integrated and any changes @quintijn has for https://github.com/dougransom/natlink/tree/umt_july22 have been pulled to DT:master as well so we can have a working unicode asap- that is the most important thing to me, since everything else works. I would prefer to cut a release that works with unimacro before doing the changes for this issue so we can get something working on peoples desk. There might not be any changes to natlinkcore for unimacro but we don't know yet.

I don't think this issue it is urgent, just important. It just can be confusing to work on. We can cut a release at any time of natlinkcore or natlink the way it is now.

We should endevour to keep the master of natlink and natlinkcore releasable at any time and do so frequently (like about monthly if there are any changes).

dougransom commented 2 years ago

PR Submitted https://github.com/dictation-toolbox/natlink/pull/122. PR should be approved same time as https://github.com/dougransom/natlinkcore copied/forked into dictation toolbox.

dougransom commented 2 years ago

done, see https://github.com/dictation-toolbox/natlinkcore