Skip to content

Make CITATION.cff optional #33

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Make CITATION.cff optional #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
23bdbb6
Make citation file optional
cthoyt Nov 2, 2024
bc8198b
Update post_gen_project.py
cthoyt Nov 2, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions cookiecutter.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@
"tox",
"nox"
],
"citation_file": [
false,
true
],
"__runner": "{% if cookiecutter['runner'] == 'tox' %}tox -e{% else %}nox -s{% endif %}",
"__runner_uv": "{% if cookiecutter['runner'] == 'tox' %}--with tox-uv tox -e{% else %}nox -s{% endif %}",
"__runner_pip": "{% if cookiecutter['runner'] == 'tox' %}tox tox-uv{% else %}nox[uv]{% endif %}",
Expand Down
3 changes: 3 additions & 0 deletions hooks/post_gen_project.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,3 +22,6 @@
PROJECT_DIRECTORY.joinpath("noxfile.py").unlink()
else:
PROJECT_DIRECTORY.joinpath("tox.ini").unlink()

if "{{ cookiecutter.citation_file|lower }}" == "false":
PROJECT_DIRECTORY.joinpath("CITATION.cff").unlink()
4 changes: 3 additions & 1 deletion {{cookiecutter.package_name}}/MANIFEST.in
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,4 +8,6 @@ prune docs
global-exclude *.py[cod] __pycache__ *.so *.dylib .DS_Store *.gpickle .idea/**

include README.md LICENSE
exclude tox.ini .readthedocs.yml .cruft.json CITATION.cff docker-compose.yml Dockerfile noxfile.py
exclude .readthedocs.yml .cruft.json docker-compose.yml Dockerfile
exclude {% if cookiecutter['runner'] == 'tox' %}tox.ini{% else %}noxfile.py{% endif %}
{%- if cookiecutter.citation_file|lower == "true" %}exclude CITATION.cff{% endif %}
2 changes: 2 additions & 0 deletions {{cookiecutter.package_name}}/pyproject.toml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -238,7 +238,9 @@ filename = "src/{{cookiecutter.package_name}}/version.py"
search = "VERSION = \"{current_version}\""
replace = "VERSION = \"{new_version}\""

{% if cookiecutter.citation_file|lower == "true" %}
[[tool.bumpversion.files]]
filename = "CITATION.cff"
search = "version: {current_version}"
replace = "version: {new_version}"
{% endif %}