Skip to content
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.

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

Add CITATION.cff #841

Merged
merged 1 commit into from
Jan 4, 2023
Merged

Add CITATION.cff #841

merged 1 commit into from
Jan 4, 2023

Conversation

gutzbenj
Copy link
Member

@gutzbenj gutzbenj commented Jan 2, 2023

This adds

  • CITATION.cff
  • small script to generate it
  • poe command to run generation

Notice: release date is not parsed from changelog (possible source) but just set to current date

@codecov
Copy link

codecov bot commented Jan 2, 2023

Codecov Report

Base: 89.53% // Head: 89.55% // Increases project coverage by +0.01% 🎉

Coverage data is based on head (a6f1a04) compared to base (2490f4d).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #841      +/-   ##
==========================================
+ Coverage   89.53%   89.55%   +0.01%     
==========================================
  Files         101      101              
  Lines        7205     7206       +1     
  Branches      672      672              
==========================================
+ Hits         6451     6453       +2     
+ Misses        585      584       -1     
  Partials      169      169              
Flag Coverage Δ
unittests 89.55% <100.00%> (+0.01%) ⬆️

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

Impacted Files Coverage Δ
wetterdienst/core/scalar/request.py 86.09% <100.00%> (+0.03%) ⬆️
wetterdienst/ui/explorer/app.py 72.47% <0.00%> (+0.45%) ⬆️

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

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

@amotl
Copy link
Member

amotl commented Jan 3, 2023

Thank you for this patch. I think it is sweet to generate the citation file from project metadata. However, I am not sure if that should be part of the wetterdienst package, given that it is not used at runtime.

@gutzbenj
Copy link
Member Author

gutzbenj commented Jan 3, 2023

I excluded the file via exclude in pyproject.toml.

@amotl
Copy link
Member

amotl commented Jan 4, 2023

I excluded the file via exclude in pyproject.toml.

It will still count towards code coverage. Maybe let's add it into a bin or tools folder?

pyproject.toml Outdated Show resolved Hide resolved
pyproject.toml Outdated Show resolved Hide resolved
content = Path(ROOT / "pyproject.toml").read_text()
raw = tomli.loads(content)
config = {"project": raw["tool"]["poetry"]}
config["project"]["authors"] = [{"name": author.split("<")[0][:-1]} for author in config["project"]["authors"]]
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is this the only modification to the upstream code? I am just trying to get a grip on the details, to eventually submit your improvements back to the cff-from-621 project.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Those two adjustments had to be made because cff-from-621 does not support poetry type format.

"""
content = Path(ROOT / "pyproject.toml").read_text()
raw = tomli.loads(content)
config = {"project": raw["tool"]["poetry"]}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh. This line is probably also needed for compatibility with Poetry?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants