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

Add executable entry in bin #42

Merged
merged 7 commits into from Feb 26, 2017
Merged

Add executable entry in bin #42

merged 7 commits into from Feb 26, 2017

Conversation

pawamoy
Copy link
Contributor

@pawamoy pawamoy commented Feb 22, 2017

This PR adresses issue #41.
It adds an executable in bin directory called license-compatibility.

The executable usage is as follow:

Usage: license-compatibility -h | -v | -s LICENSE_LIST | -a PKG_LICENCE_LIST
   -h, --help       Show this help.
   -v, --version    Show the version number (1.4.0).

   -s, --simple LICENSE_LIST
                    Check the compatibility between each possible combination of given licenses.
                    LICENSE_LIST is a list of arguments.
   -a, --advanced PKG_LICENSE_LIST
                    Check the overall licenses compatibility for a project's dependencies.
                    PKG_LICENSE_LIST is a list of arguments formatted like PACKAGE:LICENSE.

Note that the -a option is not implemented yet.

What do you think of this WIP?

@andrew
Copy link
Contributor

andrew commented Feb 22, 2017

@pawamoy that's looking great, are you planning to implement --advanced in a separate pull request or update this one?

Would also be good to have some basic test coverage of the CLI

👍

@pawamoy
Copy link
Contributor Author

pawamoy commented Feb 22, 2017

I will update this PR with advanced option, I just wanted a quick feedback from you before going further. I'm goind to add some tests also :)

@pawamoy
Copy link
Contributor Author

pawamoy commented Feb 25, 2017

Usage is now:

Usage: license-compatibility [-h] [-v] [-r file] [args]

Arguments:
    List of licenses or list of package:license couples (separated by ':').
    Example: 'MIT' 'GPL-3.0' or 'my_package:ISC' 'other_pkg:BSD-2-Clause'.
    Mixing the two formats is not allowed.
    Additional args after a --read option are accepted.

Options:
    -l, --list                       Print the list of supported licenses.
    -r, --read FILE                  Read arguments from file.
    -v, --version                    Show the program version (1.4.0).
    -h, --help                       Print this help.

@andrew
Copy link
Contributor

andrew commented Feb 25, 2017

Awesome, is this ready for merging? Would be good to add the usage section to the readme too

@pawamoy
Copy link
Contributor Author

pawamoy commented Feb 25, 2017

Cool :) No its not ready, we just need some more tests, and as you said the README section! Also the --list option needs to be better formatted.

@pawamoy
Copy link
Contributor Author

pawamoy commented Feb 26, 2017

Kay I think its good now

@andrew andrew merged commit 256ce36 into librariesio:master Feb 26, 2017
@andrew
Copy link
Contributor

andrew commented Feb 26, 2017

🎉 I've just published this to rubygems as v2.0.0: https://libraries.io/rubygems/license-compatibility/2.0.0

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