Document the usage with python -m

Makefile

@@ -55,6 +55,7 @@ test_examples:
 	cd example/project_root/;pwd;rm -rf /tmp/dynaconf_project_root_test/settings.py;mkdir -p /tmp/dynaconf_project_root_test/;echo "MESSAGE = 'Hello from tmp'" > /tmp/dynaconf_project_root_test/settings.py;python app.py;rm -rf /tmp/dynaconf_project_root_test/
 	cd example/settings_file/;pwd;rm -rf /tmp/settings_file_test/settings.py;mkdir -p /tmp/settings_file_test/;echo "MESSAGE = 'Hello from tmp'" > /tmp/settings_file_test/settings.py;python app.py;rm -rf /tmp/settings_file_test/
 	cd example/configure/;pwd;rm -rf /tmp/configure_test/settings.py;mkdir -p /tmp/configure_test/;echo "MESSAGE = 'Hello from tmp'" > /tmp/configure_test/settings.py;python app.py;rm -rf /tmp/configure_test/
+	cd example/-m_case/;pwd;python -m module
 
 	@echo '###############  Calling from outer folder  ###############'
 	python example/common/program.py
@@ -208,7 +209,7 @@ publish:
 
 clean:
 	@find ./ -name '*.pyc' -exec rm -f {} \;
-	@find ./ -name '__pycache__' -exec rm -rf {} \;
+	@find ./ -name '__pycache__' -prune -exec rm -rf {} \;
 	@find ./ -name 'Thumbs.db' -exec rm -f {} \;
 	@find ./ -name '*~' -exec rm -f {} \;
 	rm -rf .cache

docs/settings_files.md

@@ -80,6 +80,10 @@ from dynaconf import Dynaconf
 settings = Dynaconf(settings_files=["settings.toml", "/etc/program/foo.yaml"])
 ```
 
+!!! info
+    To use `python -m module`, where the module uses dynaconf you will need to
+    specify your `settings.toml` path, for example, like this: `settings_file="module/config/settings.toml"`.
+
 ### settings.toml
 
 In the above example, dynaconf will try to load `settings.toml` from the same

example/-m_case/module/__main__.py

@@ -0,0 +1,12 @@
+from dynaconf import Dynaconf
+
+settings = Dynaconf(
+    settings_file="module/config/settings.toml",
+    environments=True,
+)
+
+
+print(settings.WORKS)  # noqa
+
+
+assert "-m_case" == getattr(settings, "WORKS")

example/-m_case/module/config/settings.toml

@@ -0,0 +1,2 @@
+[default]
+works = '-m_case'

example/format/.env

@@ -1 +1 @@
-USERNAME='robert_plant'
+FORMAT_USERNAME='robert_plant'

example/format/app.py

@@ -2,9 +2,9 @@
 
 from dynaconf import settings
 
-assert settings.get("USERNAME") is None
+assert settings.get("FORMAT_USERNAME") is None
 assert settings.DATABASE_NAME == "my_database.db"
-assert os.environ["USERNAME"] == "robert_plant"
+assert os.environ["FORMAT_USERNAME"] == "robert_plant"
 
 DB_PATH = "/home/robert_plant/databases/my_database.db"
 assert settings.DATABASE_PATH == DB_PATH, settings.DATABASE_PATH

example/format/settings.toml

@@ -2,5 +2,5 @@
 database_name = 'my_database.db'
 
 [development]
-database_path = '@format /home/{env[USERNAME]}/databases/{this[database_name]}'
-database_path_jinja = '@jinja /home/{{env.USERNAME}}/{{this.current_env | lower}}/{{this["database_name"] }}'
+database_path = '@format /home/{env[FORMAT_USERNAME]}/databases/{this[database_name]}'
+database_path_jinja = '@jinja /home/{{env.FORMAT_USERNAME}}/{{this.current_env | lower}}/{{this["database_name"] }}'