search

biosimulators / Biosimulators_utils

Utilities for building standardized command-line interfaces for biosimulation software packages
https://docs.biosimulators.org/Biosimulators_utils
MIT License
4 stars 6 forks source link

Add commandline output for licence #62

Open bilalshaikh42 opened 4 years ago

bilalshaikh42 commented 4 years ago

According to GPL:

If the program does terminal interaction, make it output a short notice like this when it starts in an interactive mode:

{project}  Copyright (C) {year}  {fullname}
This program comes with ABSOLUTELY NO WARRANTY; for details type `show w'.
This is free software, and you are welcome to redistribute it
under certain conditions; type `show c' for details.

The hypothetical commands show w' andshow c' should show the appropriate parts of the General Public License. Of course, your program's commands might be different; for a GUI interface, you would use an "about box".

We can add a field to main.py that contains any needed licence text and options for displaying the licence

bilalshaikh42 commented 4 years ago

This actually may not be necessary as the docker files will not contain any code that is GPL licensed themselves. We can keep the repository MIT licensed according to the following from the Linux Foundation

The license of dockerfiles vs. software inside containers
The Dockerfile files can be licensed under an open source license themselves. It is vital to realize that the scope of this license statement is only the Dockerfile and not the container image.

For example, the Dockerfile itself can be licensed under the MIT license but describing the installation of GPL licensed software. In a typical use case, the license of the Dockerfile and the license of the described software are entirely independent.
jonrkarr commented 4 years ago

I think this is mainly an issue for the individual containers and their command-line interfaces. The template and documentation can simply state that command-line programs should state license terms as necessary.

I don't think this applies to our current simulators

This would apply to some of the other simulators we're targeting

jonrkarr commented 3 years ago

This could be incorporated into biosimulators_utils.simulator.cli.