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

Reflect over the current's deployers package design #2024

Closed
Tracked by #1917
GeorgianaElena opened this issue Jan 6, 2023 · 1 comment · Fixed by #3094
Closed
Tracked by #1917

Reflect over the current's deployers package design #2024

GeorgianaElena opened this issue Jan 6, 2023 · 1 comment · Fixed by #3094
Assignees

Comments

@GeorgianaElena
Copy link
Member

Context

In #1938 @sgibson91 correctly pointed out the naming of the files and possible their location in deployer/grafana and deployer/generate might need more thought put into it.

Proposal

Reflect over the design of:

  • deployer/grafana
  • deployer/generate
  • deployer/utils.py

Updates and actions

No response

@sgibson91
Copy link
Member

sgibson91 commented Jan 6, 2023

Copying my comment across for context:

I have a small wondering on file naming. For example, now that we have a grafana subfolder, I would say that grafana/utils.py and grafana/manage_tokens.py would reduce redundancy compared to grafana/grafana_utils.py and grafana/grafana_tokens.py etc, particularly when importing, i.e. from grafana import utils versus from grafana import grafana_utils. In the utils-specific case we'd need to avoid naming clashes with the top-level utils though. Which indicates to me either (i) we are overusing utils and should be more creative in our filenaming, or (ii) I am overthinking package design :D

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
No open projects
Status: Done 🎉
2 participants