How to include config.py within Python package?

[mitches-got-glitches]

This question seems quite simple but I'm really struggling to find a clear answer. So when you run dynaconf init the config.py file is created in the project root along with the settings.toml. In order to import this as from config import settings you need to add the project root to your PYTHONPATH. In the docs it looks like you put all of the Validators in the .py file. When a user installs your package I assume you want the config validation rules to be installed with them. So how do you supply config.py within the main package?

The alternative approach I tend to take is to put config.py in the top level of the package. Therefore it's already installed on the path when you install the package as editable and is importable with from my_package.config import settings.

Is there anything wrong with this approach? What am I missing on the default approach where the file is in the project root?

[pedro-psb]

This question seems quite simple but I'm really struggling to find a clear answer. So when you run dynaconf init the config.py file is created in the project root along with the settings.toml.

From what I've talked to Bruno, Dynaconf was mainly moved forward by webserver/app needs (not libs), so that may help explain some default behaviors. But that doesn't inherently prevent other uses. The init (the way I see it) is only a utility to help get something working from day 0, but in any case (webservers or libraries) you'll have to fine-tune this for a real project.

The alternative approach I tend to take is to put config.py in the top level of the package.

This seems reasonable to me.

[mitches-got-glitches]

Thanks - that clears things up.