Add optional readme.txt support

[mbargull]

This adds the ability to show an included readme during installation, similar to how it's done with the license file.
The readme will only be included if the new key readme_file defined in construct.yaml.

[megies]

I think this would be a nice addition.

Especially since it would be nice to show our license and then also show a notice about Anaconda EULA.

Edit: For now, I think I'll resort to not show a full license or EULA text but rather a combined notice on Anaconda EULA and license info with links to look up those licenses online..

[msarahan]

@mbargull I'm in favor of merging this. Do you have time to fix the merge conflict? I currently do not, but I can add it to the list...

[mingwandroid]

I'm in favour too but please also add macOS pkg support.

[mbargull]

I rebased this on master.
But I don't think there is currently much for me to do regarding the macOS pkgs. Those diverge from the other systems in that a readme is already generated. Hence, before I could add support for macOS, it has to be decided whether an explicit readme_file would replace the generated one or not (which would remove the macOS-only functionality of listing the to-be-installed package list). What's your opinion on that @mingwandroid?

[mingwandroid]

Maybe using the readme identified but having a flag as to whether to augment it or not would be best? Then we could add the augmentation to the other platforms too?

I should say, most of the active development is happening in this branch:

https://github.com/conda/constructor/tree/cross_conda_interface

.. so you may want your furture PRs to target that to avoid significant rebasing.

Your work on constructor is appreciated btw.

[mbargull]

Maybe using the readme identified but having a flag as to whether to augment it or not would be best? Then we could add the augmentation to the other platforms too?

A single flag might be too inflexible though. Picture a readme like:

Very informative read me. I haz packages:
__GENERATED_PACKAGE_LIST__
Some important footer line.

So, possibly the package list cannot always be simply appended to the readme. Maybe the readme files should thus be some kind of template file which can be augmented with a package list (or even, additionally, with information from the info dictionary, e.g., info['name'] and info['version'].). Especially given the current osx readme.rtf use case, the package list might even need to be formatted in a certain way.
Maybe we could leverage jinja2's capabilities for this, e.g., turn the current constructor/osx/readme_header.rtf into a jinja2 template with access to the info dictionary? This way the loop over info["_dists"] inside constructor.osxpkg:write_readme could be implemented in jinja2 and replicate the current behavior. The same could then be done for the other platforms.

Here's what I propose: For this PR I can implement the simple replacement for osx, i.e., if readme_file is present, simply insert this plain text file (as is done for the other platforms) instead of the readme.rtf. The other aspect, i.e., augmenting readme files with package lists, will be discussed/implemented in another issues/PR. Are you good with this proposal?

I should say, most of the active development is happening in this branch:

https://github.com/conda/constructor/tree/cross_conda_interface

.. so you may want your furture PRs to target that to avoid significant rebasing.

Yeah I noticed -- would've done so anyway ;).

Your work on constructor is appreciated btw.

Thanks, you're welcome!

[github-actions]

Hi there, thank you for your contribution!

This pull request has been automatically marked as stale because it has not had recent activity. It will be closed automatically if no further activity occurs.

If you would like this pull request to remain open please:

1. Rebase and verify the changes still work
2. Leave a comment with the current status

NOTE: If this pull request was closed prematurely, please leave a comment.

Thanks!

[github-actions]

Hi again!

This pull request has been closed since it has not had recent activity.

NOTE: If this pull request was closed prematurely, please leave a comment.

Thanks!