rename program to package

[AlexandroBerumen]

I searched the LoggingHeader class and renamed variables named program to package. If there is more to this PR please let me know. Thanks!

What is this PR

• Bug fix
• Addition of a new feature
• Other

Why is this PR needed?
-Currently the package variable is renamed to program when it is passed to LoggingHeader. It would make sense to rename this from program to package so that the naming is internally consistent.

What does this PR do?
-variables named "program" to "package"

References

Please reference any existing issues/PRs that relate to this PR.

-issue #55 asks if program in LoggingHeader should be called package

[codecov]

Codecov Report

❌ Patch coverage is 88.88889% with 1 line in your changes missing coverage. Please review.
✅ Project coverage is 77.83%. Comparing base (13311d5) to head (edcea1a).
⚠️ Report is 7 commits behind head on main.

Files with missing lines	Patch %	Lines
fancylog/fancylog.py	88.88%	1 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #60      +/-   ##
==========================================
+ Coverage   71.51%   77.83%   +6.31%     
==========================================
  Files           3        3              
  Lines         158      203      +45     
==========================================
+ Hits          113      158      +45     
  Misses         45       45              

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:

• ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

[JoeZiminski]

Hey @AlexandroBerumen, thanks for this! This will help make the code easier to understand. There are a couple of instances of the name program also in the write_git_info function. Would you be able to rename these also? (program_name -> package_name, program_path -> package_path). Then I'll follow up with a full test and review, cheers!

[adamltyson]

Hi @AlexandroBerumen, just checking it to see if you have some time to finish this off? Otherwise we can take it over. Thanks!

[JoeZiminski]

Hi @AlexandroBerumen, thanks again for this. I have renamed those last few variables so this is good to go, will merge now. Cheers!

[JoeZiminski]

Hey @adamltyson what do you think about codecov? I'm not sure how this PR could have led to coverage differences 🤔

[adamltyson]

Not sure, I think we can ignore it.

Do we need to update any docs, or usage in any other tools?

[JoeZiminski]

It is a public facing argument so this is a breaking change. The argument name program doesn't appear in the README.md or example.py by name (let me know if missing any other doc places). But if packages that use fancylog are passing the variable by name into start_logging it will need updating.

[adamltyson]

We should probably keep backwards compatibility for some time and add a deprecation notice in that case I think. Fancylog isn't used that much (I don't think) but I don't know all the places that would need updating.

[JoeZiminski]

Good point @adamltyson, properly deprecated it now (assuming 0.6.0 will be the next version and we can remove it 0.7.0).

[adamltyson]

Looks good, thanks @AlexandroBerumen & @JoeZiminski. I will merge, but hold off releasing for a bit until we're sure that v0.5.3 has no issues (after the issues in #71).