feat: add initial project structure with license, README, and pre-commit configuration

This commit is contained in:
2025-03-25 18:22:10 +00:00
parent 3effc087a3
commit 38ba3fa69b
5 changed files with 109 additions and 4 deletions

2
.gitignore vendored
View File

@@ -8,6 +8,7 @@ env/
# Configuration # Configuration
config/config.ini config/config.ini
config/mcp_config.json
# IDE # IDE
.vscode/ .vscode/
@@ -18,4 +19,5 @@ config/config.ini
# resources # resources
resources/ resources/
# __pycache__/ # __pycache__/

15
.pre-commit-config.yaml Executable file
View File

@@ -0,0 +1,15 @@
repos:
- repo: https://github.com/astral-sh/ruff-pre-commit
rev: v0.1.11
hooks:
- id: ruff
args: [--fix]
- id: ruff-format
- repo: https://github.com/pre-commit/pre-commit-hooks
rev: v4.5.0
hooks:
- id: trailing-whitespace
- id: end-of-file-fixer
- id: check-yaml
- id: check-added-large-files

21
LICENSE Executable file
View File

@@ -0,0 +1,21 @@
MIT License
Copyright (c) 2025 Abhishek Bhakat
Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

0
README.md Normal file
View File

View File

@@ -1,16 +1,83 @@
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[project] [project]
name = "streamlit-chat-app" name = "streamlit-chat-app"
version = "0.1.0" version = "0.1.0"
description = "Streamlit chat app with MCP"
readme = "README.md"
requires-python = ">=3.11"
authors = [
{name = "Abhishek Bhakat", email = "abhishek.bhakat@hotmail.com"}
]
dependencies = [ dependencies = [
"streamlit", "streamlit",
"python-dotenv", "python-dotenv",
"openai", "openai",
"dolphin-mcp" "dolphin-mcp"
] ]
classifiers = [
"Development Status :: 3 - Alpha",
"Operating System :: OS Independent",
"Programming Language :: Python :: 3.12",
"Programming Language :: Python :: 3.11",
]
license = "MIT"
license-files = ["LICEN[CS]E*"]
[project.urls]
GitHub = "https://git.bhakat.dev/abhishekbhakat/mcpapp"
Issues = "https://git.bhakat.dev/abhishekbhakat/mcpapp/issues"
[project.optional-dependencies]
dev = [
"build>=1.2.2",
"pre-commit>=4.0.1",
"pytest>=8.3.4",
"pytest-asyncio>=0.25.0",
"pytest-mock>=3.14.0",
"ruff>=0.9.2"
]
[build-system]
requires = ["hatchling"]
build-backend = "hatchling.build"
[tool.hatch.build.targets.wheel] [tool.hatch.build.targets.wheel]
packages = ["src"] packages = ["src"]
[tool.ruff]
line-length = 200
indent-width = 4
fix = true
preview = true
lint.select = [
"E", # pycodestyle errors
"F", # pyflakes
"I", # isort
"W", # pycodestyle warnings
"C90", # Complexity
"C", # flake8-comprehensions
"ISC", # flake8-implicit-str-concat
"T10", # flake8-debugger
"A", # flake8-builtins
"UP", # pyupgrade
]
lint.ignore = [
"C416", # Unnecessary list comprehension - rewrite as a generator expression
"C408", # Unnecessary `dict` call - rewrite as a literal
"ISC001" # Single line implicit string concatenation
]
lint.fixable = ["ALL"]
lint.unfixable = []
[tool.ruff.format]
quote-style = "double"
indent-style = "space"
skip-magic-trailing-comma = false
[tool.ruff.lint.isort]
combine-as-imports = true
[tool.ruff.lint.mccabe]
max-complexity = 12