update faqs; README

Author: RecursiveZero

.env.local

@@ -2,4 +2,4 @@
 ENVIRONMENT=development
 
 MONGODB_URI="mongodb://<user>:<password>@127.0.0.1:27017/?retryWrites=true&w=majority&appName=sample"
-DATABASE_NAME="sample"
+DATABASE_NAME="sample"

.streamlit/config.toml

@@ -11,7 +11,7 @@ toolbarMode = "viewer"
 hideTopBar = false
 
 [theme]
-base = "light"
+base = "dark"
 primaryColor = "#4b9fffff"
 backgroundColor = "#FFFFFFFF"
 secondaryBackgroundColor = "#F0F2F6FF"

.streamlit/secrets.toml

@@ -9,5 +9,5 @@ GEMINI_API = ""
 GROQ_API = "gsk_"
 
 [mongodb]
-MONGODB_URI = "mongodb://<user:<password>@127.0.0.1:27017/sample-server?authSource=admin&retryWrites=true&w=majority&appName=sample"
+MONGODB_URI = "mongodb://admin:1234@127.0.0.1:27017/sample-server?authSource=admin&retryWrites=true&w=majority&appName=sample"
 DATABASE_NAME = "sample"

.vscode/Python.code-profile

@@ -12,7 +12,8 @@
     "aaron-bond.better-comments",
     "Heron.firefox-devtools-theme",
     "GitHub.github-vscode-theme",
-    "ms-python.python",
-    "yzhang.markdown-all-in-one"
+    "yzhang.markdown-all-in-one",
+    "tamasfe.even-better-toml",
+    "ms-python.vscode-python-envs"
   ]
-}
+}

.vscode/extensions.json

@@ -40,7 +40,7 @@ Ensure below files are configured (create if not exist) properly to run the proj
 
 ```bash
 poetry lock --no-cache --regenerate
-poetry install  --with dev
+poetry install  --all-extras --with dev
 ```
 
 Or manually
@@ -126,22 +126,35 @@ pip install sample
 
 current version will be printed on start of above commands.
 
+## Install GIT hooks
+
+these hooks will
+
+- Check for lint and audit for security before commit
+- Append branch name in commit message
+- Generate requirements.txt on checkout on new branch
+
+```bash
+# Install git hooks
+poetry run ./scripts/setup-hooks.sh
+```
+
+there is `.vscode/Python.code-profile` file; import this as a profile in vscode which include necessary extension for python development.
 
 ## Troubleshooting
 
 sometimes there might be chances that virtual environment get corrupted then delete the old virtual environment and start afresh.
 
 ```sh
-poetry env info 
-# this will provide virtual environment name 
+poetry env info
+# this will provide virtual environment name
 poetry env remove <environment-full-name>
-```   
+```
 
 ## License
 
 [MIT](./LICENSE)
 
-
 ## References
 
 - [Python Downloads](https://www.python.org/downloads)
@@ -150,7 +163,3 @@ poetry env remove <environment-full-name>
 - [Poetry Docs](https://python-poetry.org/docs/)
 - [MyPy Docs](https://mypy.readthedocs.io/en/stable/running_mypy.html#missing-imports)
 - [Useful Poetry commands](./docs//POETRY_COMMANDS.md)
-
-
-
-

README.md

@@ -1,12 +1,12 @@
 [project]
 name = "sample"
 version = "0.0.5"
-description = "A package template for Recursive zero."
+description = "A python template for fastapi and streamlit projects."
 authors = [{ name = "sample", email = "recursivezero@outlook.com" }]
 license = "MIT"
 readme = "README.md"
 requires-python = ">=3.10,<3.13"
-keywords = ["image", "fastapi", "streamlit"]
+keywords = ["python", "fastapi", "streamlit"]
 classifiers = [
   "Programming Language :: Python :: 3",
   "Topic :: Scientific/Engineering :: Image Recognition",

pyproject.toml

@@ -41,7 +41,7 @@
     "explorer.fileNesting.enabled": true,
     "explorer.fileNesting.patterns": {
       "pyproject.toml": "poetry.lock,ruff.toml,.pip-audit.toml",
-      ".gitignore": ".prettier*, .poetryignore, .editorconfig, .eslint*, .npm*, .markdown*, .flake8, .env*, mypy.ini",
+      ".gitignore": ".gitattributes, .poetryignore, .editorconfig, .eslint*, .npm*, .markdown*, .flake8, .env*, mypy.ini",
       "README.md": "*.md, requirements.txt,packages.txt",
       "LICENSE": "LICENSE-*"
     },
@@ -95,12 +95,14 @@
       "sideBar.border": "#6d4589"
     },
     "peacock.color": "#523467",
-    "cSpell.words": [],
+    "cSpell.words": [
+      "gitstash"
+    ],
     "files.autoSave": "onFocusChange",
     "editor.dragAndDrop": false,
     "editor.tabCompletion": "onlySnippets",
     "editor.formatOnSaveMode": "file",
-    "files.eol": "\r\n",
+    "files.eol": "\n",
     "files.readonlyExclude": {
       "dist/**": true
     },
@@ -134,7 +136,6 @@
       "diffEditor.ignoreTrimWhitespace": true
     },
     "files.readonlyInclude": {
-      ".githooks/**": true,
       ".venv/**": true
     },
     "workbench.editor.pinnedTabsOnSeparateRow": true,
@@ -145,6 +146,7 @@
       "./src"
     ],
     "files.exclude": {
+      ".git/**": true,
       ".poetry/**": true,
       "**/.git": false
     },
@@ -153,18 +155,14 @@
       "servers": {}
     },
     "chat.mcp.serverSampling": {
-      "sample-py.code-workspace: my-mcp-server-c37295de": {
+      "tz-script.code-workspace: my-mcp-server-c37295de": {
         "allowedModels": [
           "copilot/gpt-4.1",
           "copilot/claude-3.5-sonnet"
         ]
       }
     },
     "gitstash.explorer.display.fileSorting": "tree",
-    "folderStructure.ignorePatterns": [
-      "node_modules",
-      ".*",
-      "__pycache__"
-    ],
+    "files.insertFinalNewline": true,
   }
-}
+}

sample-py.code-workspace

@@ -1,4 +1,4 @@
-from db.db_connection import mongo_client
+from db.connection import mongo_client
 
 if mongo_client:
-  print("MongoDB connection successfull")
+  print("MongoDB connected successfully.")