Skip to content

Commit ed605d5

Browse files
committed
Use description in README and update example description
This makes the example repo more readable on PyPI Also fix test that updates example to use answers from example-answers.yml
1 parent ded241c commit ed605d5

File tree

3 files changed

+4
-5
lines changed

3 files changed

+4
-5
lines changed

example-answers.yml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
author_email: [email protected]
22
author_name: Tom Cobb
33
component_owner: group:default/sscc
4-
description: An expanded python-copier-template with all the options
4+
description: An expanded https://github.com/DiamondLightSource/python-copier-template to illustrate how it looks with all the options enabled.
55
distribution_name: dls-python-copier-template-example
66
docker: true
77
docs_type: sphinx

template/README.md.jinja

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,8 @@
55

66
# {{ package_name }}
77

8+
{{description}}
9+
810
This is where you should write a short paragraph that describes what your module does,
911
how it does it, and why people should use it.
1012

tests/test_example.py

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -81,12 +81,9 @@ def test_example_repo_updates(tmp_path: Path):
8181
run("git config user.email '[email protected]'")
8282
run("git config user.name 'Your Name'")
8383
run("git commit -am 'Update src'")
84-
run("copier update --trust --vcs-ref=HEAD -A")
84+
run(f"copier update --trust --vcs-ref=HEAD --data-file {TOP}/example-answers.yml")
8585
output = run(
8686
"diff -ur --exclude=.git --ignore-matching-lines='_commit: '"
8787
f" {generated_path} {example_path}"
8888
)
8989
assert not output, output
90-
91-
92-
# TODO: check that copier update python-copier-template-example matches generated

0 commit comments

Comments
 (0)