Merge pull request #1 from recursivezero/develop

Develop

Author: recursivezero

.env.local

@@ -1,14 +1,5 @@
 #Note specify the values within double-quotes("")
 ENVIRONMENT=development
 
-AWS_BUCKET_NAME=
-AWS_ACCESS_KEY_ID=
-AWS_SECRET_ACCESS_KEY=
-AWS_REGION=
-
-GEMINI_API=
-GITHUB_TOKEN="github_pat_your_github_token"
-GROQ_API="gsk_your_groq_api_key_X"
-
-MONGODB_URI="mongodb://admin:1234@127.0.0.1:27017/?retryWrites=true&w=majority&appName=sample"
-DATABASE_NAME="tz-server"
+MONGODB_URI="mongodb://<user>:<password>@127.0.0.1:27017/?retryWrites=true&w=majority&appName=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

@@ -10,4 +10,4 @@ GROQ_API = "gsk_"
 
 [mongodb]
 MONGODB_URI = "mongodb://admin:1234@127.0.0.1:27017/sample-server?authSource=admin&retryWrites=true&w=majority&appName=sample"
-DATABASE_NAME = "tz-server"
+DATABASE_NAME = "sample"

.vscode/Python.code-profile

@@ -83,7 +83,7 @@ stefanzweifel
 streamlit
 Succesfully
 sucess
-Threadzip
+Sample
 tobytes
 torchvision
 txtl

.vscode/dictionaries/project-words.txt

@@ -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

@@ -7,3 +7,7 @@ All notable changes to this repository will be documented in this file.
 - Initial release.
 
 Following version changes are required to be documented.
+
+## [0.0.5]
+
+- update env.sample

CHANGELOG.md

@@ -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)
-
-
-
-