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

Jump to bottom

Document recommended usage #20

Open

silvanmelchior opened this issue Oct 20, 2021 · 0 comments

Labels

Collaborator

silvanmelchior commented Oct 20, 2021 •

edited

Loading

So far, the documentation only describes how ConfZ can be used, but not how it is recommended to use.

A separate section in the config could go into more details about:

Complete nested config for whole project vs separate module-level config
How deep down in your layers should config still be used, when should specific values be passed down instead
When to use dataclasses instead of ConfZ classes
When to depend on typing.Protocol instead of ConfZ class
When to use local configs without singleton pattern
How to structure your project using ConfZ (e.g. file structure)

silvanmelchior added the documentation label

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment