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 listing of configuration keys #240

Merged
merged 4 commits into from
Mar 11, 2025
Merged

Conversation

jdevera
Copy link
Contributor

@jdevera jdevera commented Mar 3, 2025

Description:

A new view to list the stored configuration keys with a link to load them in the manager.

This is intended to be used in environments where secrecy is not a desired feature, as discussed in issue #200. So it is disabled by default and can be turned on by setting the APPRISE_ALLOW_CONFIG_LIST environment variable to true.

It will only work when the STATEFUL_MODE is set to simple.

Related issue (if applicable): refs #200

Checklist

  • The code change is tested and works locally.
  • There is no commented out code in this PR.
  • No lint errors (use flake8)
  • Tests added

A new view to list the stored configuration keys with a link to load
them in the manager.

This is intended to be used in environments where secrecy is not a
desired feature, as discussed in issue caronc#200. So it is disabled by
default and can be turned on by setting the APPRISE_ALLOW_CONFIG_LIST
environment variable to true.

It will only work when the STATEFUL_MODE is set to simple.
@caronc
Copy link
Owner

caronc commented Mar 9, 2025

Perhaps just calling the environment variable APPRISE_ADMIN as this would allow one to tag other feaures with Apprise that come up over time. Today it's just the config list. Later on the Admin feature could have use for other options as well?

Otherwise, thank you very much for this PR 🙏 🚀

Copy link

codecov bot commented Mar 9, 2025

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 99.83%. Comparing base (ecc8655) to head (3cb3926).
Report is 42 commits behind head on master.

Additional details and impacted files
@@            Coverage Diff             @@
##           master     #240      +/-   ##
==========================================
+ Coverage   99.37%   99.83%   +0.46%     
==========================================
  Files           7       11       +4     
  Lines         794     1187     +393     
==========================================
+ Hits          789     1185     +396     
+ Misses          5        2       -3     

☔ 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.

jdevera added 2 commits March 10, 2025 19:06
Files starting with a dot should not be considered configuration. And sometimes they are used to make sure a directory is tracked in git.
A more generic name that can be used to gate additional admin only
features.
@jdevera
Copy link
Contributor Author

jdevera commented Mar 10, 2025

Thanks for the review, I ended up naming it (APPRISE_)ADMIN_ENABLED to make its boolean nature clearer everywhere it was used.

I also changed the test to appease Codecov :P

@caronc
Copy link
Owner

caronc commented Mar 11, 2025

Just made some minor changes to your commit. Thank you for such a great job!

@caronc caronc merged commit a562452 into caronc:master Mar 11, 2025
3 checks passed
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.

2 participants