homesweethome 0.5.0

No project description provided

HomeSweetHome

HomeSweetHome is a library providing opinionated home directory and Dynaconf-based configuration for Python projects.

Usage

Let's say that your application is named myapp.

By default HomeSweetHome assumes your application directory is ~/.myapp and that default configuration file for your application is a YML file ~/.myapp/myapp.yml. In order to make sure the following structure is in place, just create SweetHome object.

from homesweethome.homesweethome import SweetHome

sweet_home = SweetHome("myapp")

Now you can read properties from the configuration YML:

from homesweethome.homesweethome import SweetHome

sweet_home = SweetHome("myapp")
host = sweet_home.read_setting("server.host")
port = sweet_home.read_setting("server.port")

Environment variables

You can read settings from environment variables as well using Dynaconf convention (i.e.APPPREFIX_FOO__BAR__BAZ pattern to read foo.bar.baz setting for application prefix APPPREFIX):

from homesweethome.homesweethome import SweetHome

sweet_home = SweetHome("myapp")
host = sweet_home.read_setting("server.host") # export MYAPP_SERVER__HOST
port = sweet_home.read_setting("server.port") # export MYAPP_SERVER__PORT

License

This project is licensed under the MIT License - see the LICENSE file for details.