Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Prepare the repo for opening #56

Merged
merged 11 commits into from
Feb 16, 2018
Merged

Prepare the repo for opening #56

merged 11 commits into from
Feb 16, 2018

Conversation

jbarnoud
Copy link
Collaborator

This PR prepares the repository to be made public.

  • The license header is added to all the files
  • The library is renamed vermouth
  • entry_api.py is renamed martinize2
  • The README is filled up
  • The license of the redistributed kdtree is now respected

@Tsjerk could you have a look? I would like to merge this by tomorrow so I can open the repo. I'd prefer not to merge my own PR without review.

The `embed_test.py`, anf `run_martinize2.py` are now located in the
`bin` directory instead of the root of the repository.

It goes the same for `entry_api.py`. In addition, this last script is
renamed `martinize2`, and get installed in the research PATH by setup.py.
The martinize2 library get renamed vermouth as it covers more than
martinize. This commit renames the library main directory.

WARNING: this commit breaks everything as the library is still referred
to as martinize2. Yet, making this commit separate should prevent a lot
of hassle with merge conflicts.
@jbarnoud
Copy link
Collaborator Author

I just spent 3 hours rebasing my other pull requests against that one. Damn! It was some serious history rewriting! I'll update the PRs when this will be validated.

Copy link
Collaborator

@Tsjerk Tsjerk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Most looks good; The issue on licensing data is something to discuss, I guess. I'd be in favour of having a completely open license for that. If these data files are to appear in a database or sent around separately, I wouldn't want to see that as 'derived work' from vermouth.

setup.cfg Outdated
@@ -2,7 +2,7 @@
universal = 1

[metadata]
name = martinize2
name = vermouth
author = P C Kroon
author_email = [email protected]
license = MIT
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Still says MIT as license...

; WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
; See the License for the specific language governing permissions and
; limitations under the License.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't these have a Data License, rather than a Software License?

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would say that the safest is to apply the same license everywhere for the time being. We could apply a different license for the data (CC zero?) but it requires some more discussion, and I would like to open the repo.

@jbarnoud
Copy link
Collaborator Author

@Tsjerk done. For the data, as I wrote in my comment above I am in favour of having them with the Apache license until we discuss the matter further with @pckroon and Siewert.

@Tsjerk Tsjerk merged commit b3858c3 into master Feb 16, 2018
@Tsjerk Tsjerk deleted the make_public branch February 16, 2018 11:52
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants