Merge lantz-core and lantz repositories #4
Merged
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a pull request to merge the lantz and lantz-core repositories into a single lantz repository (here, lantz refers to the lantzproject/lantz repository). The reason for this is very simple: lantz-core is the main repository of the project but is functionally incomplete and broken on install. If you install lantz-core separately from lantz (i.e.
pip install lantz-core
), then lantz does not get correctly installed; this is due to the missing init.py and main.py files from the lantz repository.The only way to fix this would be to make lantz a dependency of lantz-core, but since lantz-core is already a dependency of lantz, this would create a circular dependency. This is bad programming etiquette.
The lantz repository is simply a shell for specifying the various install options for the lantz project, since it's submodules have been broken into separate repositories (the merits of which could be debated separately). There is no reason why these options could not be specified within the lantz-core config files itself. In fact, lantz-core is a required install regardless of extra options on the lantz install (i.e.
pip install lantzdev
). Finally, for new users and contributors this makes the project confusing -- they are directed to the lantz repository but all the useful files for contributing are in lantz-core (at a minimum).These are all strong arguments in favor of merging the lantz repository into the lantz-core repository. I further recommend archiving the lantz project and making it's visibility hidden so that the lantz-core repository can then be renamed to lantz in keeping with the project name (merging in this direction is simpler than merging in the reverse direction; additionally, the heart of the project with stay in the same repository minimizing the resulting complexity of the commit history).
I have moved over the root lantz directory, the documentation, the scripts, and the requirements files. Additionally, I have completely updated the setup.py install to reflect the current state of the project. Other files (such as MANIFEST.in) have been modified as needed.
Finally, it should be noted that following the above proposed changes will not affect current users ability to install and run lantz. The end user will not notice any difference. The modifications have been made such that if merged and published as a new version 0.6.0 to the lantzdev PyPI package, it will still be installable as lantzdev. The lantz-core PyPI package should then become deprecated.
[Also see the issue I raised about deprecating the previous project and redirecting users to the currently maintained project here https://github.com/LabPy/lantz/issues/84]
@hgrecco @jacobfeder
CHANGELOG:
commit to merge lantzproject/lantz and lantzproject/lantz-core into single repository