docs: Added samples

.gitignore

@@ -482,7 +482,6 @@ celerybeat.pid
 *.sage.py
 
 # Environments
-.env
 env/
 venv/
 ENV/

README.md

@@ -15,3 +15,15 @@ env_settings_local = get_env_settings(use_local=True)
 # to load from local .env at different location
 env_settings_local_other = get_env_settings(use_local=True, env_file='<path_to_file>')
 ```
+
+`get_env_settings` returns a class object containing all the required environment variables.
+
+To access an environment variable
+```python
+app_env = env_settings.APP_ENV
+
+# to get all as a dictionary
+env_settings.dict()
+```
+
+Sample `.env` file: 

assets/.env

+#ENV
+APP_ENV=PROD
+
+#Mongo
+MONGO_URI=mongodb://[username:password@]host1[:port1][,...hostN[:portN]][/[defaultauthdb][?options]]
+
+#Kairos
+KAIROS_URI=
+
+#MQTT
+MQTT_HOST=
+MQTT_PORT=1883
+MQTT_AUTH=
+MQTT_USERNAME =
+MQTT_PASSWORD =
+
+#KAFKA
+KAFKA_HOST=
+KAFKA_PORT=
+
+#REDIS
+REDIS_HOST=
+REDIS_PORT=
+
+# Postgres Details
+POSTGRES_URI=
+
+#OTHERSERVICES
+BASE_PROXY=
+
+SECURITY_IP_CHECK=False
+SECURITY_USER_CHECK=True
+SECURITY_AGENT_CHECK=True

ilens_env_settings/__init__.py

@@ -45,7 +45,7 @@ class EnvironmentSettings(BaseSettings):
     POSTGRES_URI: Optional[str]
 
     # Base Proxy for all services
-    BASE_PROXY: str
+    BASE_PROXY: Optional[str]
 
     # Security aspects
     SECURITY_IP_CHECK: bool = True