feat: add support for yaml data files

[Ian2012]

This PR adds support for yaml files as a data input

[sisp]

Follow-up of #485. Resolves #540.

[sisp]

Thanks for your contribution, @Ian2012!

I have a couple of minor suggestions and raised a topic for discussion around repeatedly passing the -d, --data switch with data files.

Please also add tests for both the success and failure scenarios once the conceptual discussion has been resolved.

As always, @yajo needs to perform the ultimate review, I'm only trying to support.

[Ian2012]

@sisp Thanks for your review. I've already handle all your comments, if you agree, could you resolve all the conversations so we can focus on the conceptual discussion?

[sisp]

Thanks, @Ian2012. There are still a few open suggestions of mine in the docs though. And I can't seem to mark the other comments as resolved. Can you resolve them?

[Ian2012]

Is there anything I can do to speed up the review process?

[codecov]

Codecov Report

Merging #1059 (30afa27) into master (17135c5) will decrease coverage by 0.40%.
The diff coverage is 40.00%.

❗ Current head 30afa27 differs from pull request most recent head 5c20f0c. Consider uploading reports for the commit 5c20f0c to get more accurate results

@@            Coverage Diff             @@
##           master    #1059      +/-   ##
==========================================
- Coverage   96.49%   96.09%   -0.40%     
==========================================
  Files          44       43       -1     
  Lines        3394     3203     -191     
==========================================
- Hits         3275     3078     -197     
- Misses        119      125       +6     

Flag	Coverage Δ
unittests	96.09% <40.00%> (-0.40%)	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
copier/cli.py	91.01% <40.00%> (-6.52%)	⬇️

... and 10 files with indirect coverage changes

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

[sisp]

@Ian2012 I think it would be good to mention in the docs for both --data and --data-file (with anchor links to each other) that they are mutually exclusive.

[Ian2012]

I totally agree, here is an updated version https://copier--1059.org.readthedocs.build/en/1059/configuring/#data

[yajo]

Some rewording on docs and simplification on code.

Thanks for the feature! Really helpful and a small patch. I like it a lot 😊

This needs a test though. Could you add it too please?

[sisp]

A newline is missing. Also, how about adding the short flag here as well? And shouldn't the link be an anchor link?

Suggested change

	As an alternative to [`--data`][data] you can also pass the path to a YAML file that contains your data.
	As an alternative to [`-d, --data`](#data) you can also pass the path to a YAML file that contains your data.

[sisp]

A newline is missing:

Suggested change

	!!! info
	!!! info

[Ian2012]

I would like to add tests but I'm unable to setup a development environment using local env, do you guys have the manual instructions?

When I run direnv allow it does nothing, I don't know how to install poe and the developments dependencies

[yajo]

There's a small guide in https://github.com/copier-org/copier/blob/master/CONTRIBUTING.md#dev-environment-setup

The fastest way is just to use gitpod.

[Ian2012]

@yajo I'm really struggling with the test, could you give me a hand there?

I'm not used to test

[sisp]

@Ian2012 If you're still struggling with setting up the development environment, it's typically sufficient to run

$ poetry install --with dev,docs
$ poetry run pip install black isort  # optionally but useful to get the formatters
$ poetry run poe test

if you have Git and a sufficiently recent Python interpreter installed on your system. Nix provides a complete and deterministic setup including Git, Python, pre-commit, code formatters and linters, but you should be able to develop also without it.

[yajo]

I'm not used to test

I think it's more a matter of not knowing how to do a unit test, right?

I'll try to help when I have some free time. Or maybe you can help with that @sisp?

[yajo]

Superseded by #1325.