Add initial project setup with email proposal generation functionality

.env.example

@@ -0,0 +1,6 @@
+SMTP_SERVER=
+SMTP_PORT=
+SMTP_USERNAME=
+SMTP_PASSWORD=
+SENDER_EMAIL=
+RECIPIENT_EMAIL=

.gitattributes

@@ -0,0 +1,35 @@
+*.7z filter=lfs diff=lfs merge=lfs -text
+*.arrow filter=lfs diff=lfs merge=lfs -text
+*.bin filter=lfs diff=lfs merge=lfs -text
+*.bz2 filter=lfs diff=lfs merge=lfs -text
+*.ckpt filter=lfs diff=lfs merge=lfs -text
+*.ftz filter=lfs diff=lfs merge=lfs -text
+*.gz filter=lfs diff=lfs merge=lfs -text
+*.h5 filter=lfs diff=lfs merge=lfs -text
+*.joblib filter=lfs diff=lfs merge=lfs -text
+*.lfs.* filter=lfs diff=lfs merge=lfs -text
+*.mlmodel filter=lfs diff=lfs merge=lfs -text
+*.model filter=lfs diff=lfs merge=lfs -text
+*.msgpack filter=lfs diff=lfs merge=lfs -text
+*.npy filter=lfs diff=lfs merge=lfs -text
+*.npz filter=lfs diff=lfs merge=lfs -text
+*.onnx filter=lfs diff=lfs merge=lfs -text
+*.ot filter=lfs diff=lfs merge=lfs -text
+*.parquet filter=lfs diff=lfs merge=lfs -text
+*.pb filter=lfs diff=lfs merge=lfs -text
+*.pickle filter=lfs diff=lfs merge=lfs -text
+*.pkl filter=lfs diff=lfs merge=lfs -text
+*.pt filter=lfs diff=lfs merge=lfs -text
+*.pth filter=lfs diff=lfs merge=lfs -text
+*.rar filter=lfs diff=lfs merge=lfs -text
+*.safetensors filter=lfs diff=lfs merge=lfs -text
+saved_model/**/* filter=lfs diff=lfs merge=lfs -text
+*.tar.* filter=lfs diff=lfs merge=lfs -text
+*.tar filter=lfs diff=lfs merge=lfs -text
+*.tflite filter=lfs diff=lfs merge=lfs -text
+*.tgz filter=lfs diff=lfs merge=lfs -text
+*.wasm filter=lfs diff=lfs merge=lfs -text
+*.xz filter=lfs diff=lfs merge=lfs -text
+*.zip filter=lfs diff=lfs merge=lfs -text
+*.zst filter=lfs diff=lfs merge=lfs -text
+*tfevents* filter=lfs diff=lfs merge=lfs -text

.gitignore

@@ -0,0 +1,140 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+.vscode

Dockerfile

@@ -0,0 +1,25 @@
+FROM python:3.12
+
+WORKDIR /app
+
+RUN pip install poetry
+
+RUN poetry config virtualenvs.create false
+
+COPY pyproject.toml poetry.lock /app/
+
+RUN poetry install --only main --no-root
+
+RUN useradd -m -u 1000 user
+
+RUN chown -R user /app
+
+USER user
+
+COPY --chown=user src /app/src
+
+EXPOSE 7860
+
+ENV PYTHONUNBUFFERED=1
+
+CMD ["uvicorn", "src.app:app", "--host", "0.0.0.0", "--port", "7860"]

README.md

@@ -0,0 +1,13 @@
+---
+title: Proposal Generator
+emoji: 🌍
+colorFrom: yellow
+colorTo: gray
+sdk: docker
+# sdk: streamlit
+sdk_version: 1.41.1
+app_file: app.py
+pinned: false
+---
+
+Check out the configuration reference at https://huggingface.co/docs/hub/spaces-config-reference

custom-gpt-action.yaml

@@ -0,0 +1,109 @@
+openapi: 3.1.0
+info:
+  title: Proposal Generation API
+  description: This API generates project proposals based on user input.
+  version: 1.0.0
+servers:
+  - url: https://sifars-proposal-generator.hf.space
+    description: Main server for proposal generation.
+paths:
+  /proposals/:
+    post:
+      operationId: generateProposal
+      summary: Generates a project proposal
+      requestBody:
+        required: true
+        content:
+          application/json:
+            schema:
+              $ref: "#/components/schemas/ProposalRequest"
+      responses:
+        "200":
+          description: Successfully generated proposal
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  proposal:
+                    type: string
+                    example: "Generated proposal content here."
+        "500":
+          description: Internal server error
+          content:
+            application/json:
+              schema:
+                type: object
+                properties:
+                  detail:
+                    type: string
+                    example: "Internal Server Error."
+components:
+  schemas:
+    ProposalRequest:
+      type: object
+      required:
+        - project_name
+        - project_overview
+        - project_introduction
+        - about_us
+        - background_of_the_project
+        - scope_of_work
+        - technical_approach
+        - deployment_and_integration
+        - timeline
+        - team_structure
+        - platform
+        - licensing_model
+        - risk_analysis
+        - past_projects
+      properties:
+        project_name:
+          type: string
+          description: "Generate a name of the project. In response, provide only the name and do not include any other information."
+        project_overview:
+          type: string
+          description: "Generate an overview section that improves the project overview from the client requirements. Keep the text up to 15 lines and write the text without using pronouns."
+        project_introduction:
+          type: string
+          description: "Address the client formally and thank them for considering Sifars for the project. Briefly describe Sifars, mentioning its mission, values, and focus on delivering state-of-the-art AI or software solutions."
+        about_us:
+          type: string
+          description: "Provide a short introduction to Sifars, focusing on our team's expertise, technologies, and successful solutions we have developed. Mention how long Sifars has been in operation and our experience with similar projects."
+        background_of_the_project:
+          type: string
+          description: "Describe the key challenge the client is facing in their industry (replace with the client's field, e.g., healthcare, finance). Present the problem and how Sifars will address it using advanced technologies (AI, software development, automation, etc.)."
+        scope_of_work:
+          type: string
+          description: "Detail the tasks that will be performed. Example structure: Data Collection and Preprocessing, Solution Development (e.g., AI model, software system), Integration and API development, Testing and validation, Deployment on scalable infrastructure."
+        technical_approach:
+          type: string
+          description: "Explain the approach in detail. Include methodologies like content-based and collaborative filtering if relevant, or other techniques used by Sifars. Customize this to reflect the [Techstack] that's going to be used by Sifars."
+        deployment_and_integration:
+          type: string
+          description: "Specify the deployment method, such as using cloud services like AWS, GCP, or any other infrastructure that Sifars uses or defined in the [Techstack]. Mention how Sifars ensures seamless integration with the client’s platform using APIs."
+        timeline:
+          timeline:
+            type: string
+            description: "Create a timeline with project milestones in the following table format, like:
+              | Week | Milestone                          | Estimated Pricing       |
+              |------|------------------------------------|-------------------------|
+              | 1    | Initial Setup and Data Collection  | $1,000                  |
+              | 2-3  | Development of Core Components     | $2,000                  |
+              | 4    | Final Deployment and Testing       | $1,500                  |
+              Add estimated pricing in a flexible structure, allowing payments at each milestone."
+        team_structure:
+          type: string
+          description: "Generate a detailed breakdown of a project team's structure, including roles and responsibilities. The team may consist of members like Project Manager, UI/UX Designer, Full Stack Developers, AI Developers, Quality Assurance Specialists, DevOps Engineers, etc. For each role, provide the number of members and describe their key responsibilities. Ensure that the responsibilities align with typical tasks for each role in a software development project. Use clear, professional language and ensure that the descriptions are concise yet comprehensive."
+        platform:
+          type: string
+          description: "Generate text explaining each [Techstack] the application will be built upon."
+        licensing_model:
+          type: string
+          description: "Based on the [Techstack] and other potential tooling that will be involved to build the project, generate the Licensing Model section."
+        risk_analysis:
+          type: string
+          description: "List potential risks (e.g., data availability, bias in the system) and propose mitigations."
+        past_projects:
+          type: string
+          description: "Provide case studies of similar projects Sifars has worked on, showcasing the impact and results achieved. Refer to the knowledge files to find 2 relevant projects that could be similar to the provided requirements."

instructions.json

@@ -0,0 +1,16 @@
+{
+    "project_name": "Generate a name of the project. In response provide only name and do not include any other information.",
+    "project_overview": "Generate an overview section that just improves the project overview from the client requirements. Keep the text up to 15 lines and Please write the text without using pronouns.",
+    "project_introduction": "Address the client formally and thank them for considering Sifars for the project. Briefly describe Sifars, mentioning its mission, values, and focus on delivering state-of-the-art AI or software solutions.",
+    "about_us": "Provide a short introduction to Sifars, focusing on our team's expertise, technologies, and the successful solutions we have developed. Mention how long Sifars has been in operation and our experience with similar projects.",
+    "background_of_the_project": "Describe the key challenge the client is facing in their industry (replace with the client's field, e.g., healthcare, finance). Present the problem and how Sifars will address it using advanced technologies (AI, software development, automation, etc.).",
+    "scope_of_work": "Detail the tasks that will be performed. Example structure: Data Collection and Preprocessing. Solution Development (e.g., AI model, software system). Integration and API development. Testing and validation. Deployment on scalable infrastructure.",
+    "technical_approach": "Explain the approach in detail. Include methodologies like content-based and collaborative filtering if relevant, or other techniques used by Sifars. Customize this to reflect the [ Techstack ] that's going to be used by Sifars.",
+    "deployment_and_integration": "Specify the deployment method, such as using cloud services like AWS, GCP, or any other infrastructure that Sifars uses or defined in the [ Techstack ]. Mention how Sifars ensures seamless integration with the client’s platform using APIs.",
+    "timeline": "Create a timeline with project milestones in the following table format, like: Week 1: Initial Setup and Data Collection. Week 2-3: Development of Core Components. Week 4: Final Deployment and Testing. Add estimated pricing in a flexible structure, allowing payments at each milestone.",
+    "team_structure": "Generate a detailed breakdown of a project team's structure, including roles and responsibilities. The team may consists of members like Project Manager, UI/UX Designer, Full Stack Developers, AI Developers, Quality Assurance Specialists, DevOps Engineers, etc. For each role, provide the number of members and describe their key responsibilities. Ensure that the responsibilities align with typical tasks for each role in a software development project. Use clear, professional language and ensure that the descriptions are concise yet comprehensive.",
+    "platform": "Generate text explaining each [ techstack ] the application will be built upon.",
+    "licensing_model": "Based on the [ Techstack ] and other potential tooling that will be involved to build the project, generate the Licensing Model section. ",
+    "risk_analysis": "List potential risks (e.g., data availability, bias in the system) and propose mitigations.",
+    "past_projects": "Provide case studies of similar projects Sifars has worked on, showcasing the impact and results achieved. Refer to the knowledge files to find 2 relevant projects that could be similar to the provided requirements."
+}

instructions.md

@@ -0,0 +1,74 @@
+You are an AI-powered proposal generator for Sifars, responsible for crafting professional, structured, and tailored project proposals. Follow these instructions carefully to generate a compelling and precise document:
+
+### **1. Project Name**
+
+Generate a concise, relevant project name. Provide only the name, without additional details or explanations.
+
+### **2. Project Overview**
+
+Refine the client's project overview while maintaining their core requirements. Improve clarity and readability within a limit of 15 lines. Avoid using pronouns.
+
+### **3. Project Introduction**
+
+Address the client formally and thank them for considering Sifars. Briefly introduce Sifars, highlighting its mission, values, and expertise in AI and software solutions.
+
+### **4. About Us**
+
+Summarize Sifars' background, including team expertise, technology focus, and past successes. Mention years of experience and relevant industry accomplishments.
+
+### **5. Background of the Project**
+
+Describe the client’s key industry challenge and how Sifars’ advanced technologies (AI, automation, software development, etc.) will address it. Clearly outline the problem and Sifars' tailored solution.
+
+### **6. Scope of Work**
+
+Define project tasks in a structured format, including but not limited to:
+
+- Data Collection & Preprocessing
+- Solution Development (AI model/software)
+- Integration & API Development
+- Testing & Validation
+- Deployment on scalable infrastructure
+
+### **7. Technical Approach**
+
+Describe the technical methodologies and strategies that will be used. Align the approach with the specified [Techstack] and include techniques such as AI/ML models, collaborative filtering, or other relevant methods.
+
+### **8. Deployment and Integration**
+
+Detail the deployment strategy, specifying cloud infrastructure (AWS, GCP, etc.) and integration methods. Ensure that API integration is seamless and aligns with Sifars' best practices.
+
+### **9. Timeline & Pricing**
+
+Generate a project timeline with milestone-based breakdowns. Provide a flexible pricing structure linked to milestone completions in markdown table format. Ensure the timeline and pricing are realistic and competitive.
+
+### **10. Team Structure**
+
+Define project roles and responsibilities, ensuring alignment with typical software development tasks. The team may include:
+
+- Project Manager
+- UI/UX Designer
+- Full Stack Developers
+- AI Developers
+- Quality Assurance Specialists
+- DevOps Engineers
+
+For each role, specify the number of members and their core responsibilities. Use clear, professional language.
+
+### **11. Platform**
+
+Describe the [Techstack] used for the project, explaining its relevance and benefits.
+
+### **12. Licensing Model**
+
+Generate the appropriate licensing model based on the [Techstack] and other tools required.
+
+### **13. Risk Analysis**
+
+Identify key project risks (e.g., data availability, security concerns, AI biases) and propose mitigation strategies.
+
+### **14. Past Projects**
+
+Select two relevant case studies from Sifars’ past projects that align with the client’s requirements. Highlight their impact and results.
+
+Ensure the proposal maintains a professional, clear, and structured format. Keep responses concise, factual, and aligned with Sifars' expertise.

poetry.lock

@@ -0,0 +1,358 @@
+# This file is automatically @generated by Poetry 1.7.1 and should not be changed by hand.
+
+[[package]]
+name = "aiosmtplib"
+version = "3.0.2"
+description = "asyncio SMTP client"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "aiosmtplib-3.0.2-py3-none-any.whl", hash = "sha256:8783059603a34834c7c90ca51103c3aa129d5922003b5ce98dbaa6d4440f10fc"},
+    {file = "aiosmtplib-3.0.2.tar.gz", hash = "sha256:08fd840f9dbc23258025dca229e8a8f04d2ccf3ecb1319585615bfc7933f7f47"},
+]
+
+[package.extras]
+docs = ["furo (>=2023.9.10)", "sphinx (>=7.0.0)", "sphinx-autodoc-typehints (>=1.24.0)", "sphinx-copybutton (>=0.5.0)"]
+uvloop = ["uvloop (>=0.18)"]
+
+[[package]]
+name = "annotated-types"
+version = "0.7.0"
+description = "Reusable constraint types to use with typing.Annotated"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "annotated_types-0.7.0-py3-none-any.whl", hash = "sha256:1f02e8b43a8fbbc3f3e0d4f0f4bfc8131bcb4eebe8849b8e5c773f3a1c582a53"},
+    {file = "annotated_types-0.7.0.tar.gz", hash = "sha256:aff07c09a53a08bc8cfccb9c85b05f1aa9a2a6f23728d790723543408344ce89"},
+]
+
+[[package]]
+name = "anyio"
+version = "4.8.0"
+description = "High level compatibility layer for multiple asynchronous event loop implementations"
+optional = false
+python-versions = ">=3.9"
+files = [
+    {file = "anyio-4.8.0-py3-none-any.whl", hash = "sha256:b5011f270ab5eb0abf13385f851315585cc37ef330dd88e27ec3d34d651fd47a"},
+    {file = "anyio-4.8.0.tar.gz", hash = "sha256:1d9fe889df5212298c0c0723fa20479d1b94883a2df44bd3897aa91083316f7a"},
+]
+
+[package.dependencies]
+idna = ">=2.8"
+sniffio = ">=1.1"
+typing_extensions = {version = ">=4.5", markers = "python_version < \"3.13\""}
+
+[package.extras]
+doc = ["Sphinx (>=7.4,<8.0)", "packaging", "sphinx-autodoc-typehints (>=1.2.0)", "sphinx_rtd_theme"]
+test = ["anyio[trio]", "coverage[toml] (>=7)", "exceptiongroup (>=1.2.0)", "hypothesis (>=4.0)", "psutil (>=5.9)", "pytest (>=7.0)", "trustme", "truststore (>=0.9.1)", "uvloop (>=0.21)"]
+trio = ["trio (>=0.26.1)"]
+
+[[package]]
+name = "click"
+version = "8.1.8"
+description = "Composable command line interface toolkit"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "click-8.1.8-py3-none-any.whl", hash = "sha256:63c132bbbed01578a06712a2d1f497bb62d9c1c0d329b7903a866228027263b2"},
+    {file = "click-8.1.8.tar.gz", hash = "sha256:ed53c9d8990d83c2a27deae68e4ee337473f6330c040a31d4225c9574d16096a"},
+]
+
+[package.dependencies]
+colorama = {version = "*", markers = "platform_system == \"Windows\""}
+
+[[package]]
+name = "colorama"
+version = "0.4.6"
+description = "Cross-platform colored terminal text."
+optional = false
+python-versions = "!=3.0.*,!=3.1.*,!=3.2.*,!=3.3.*,!=3.4.*,!=3.5.*,!=3.6.*,>=2.7"
+files = [
+    {file = "colorama-0.4.6-py2.py3-none-any.whl", hash = "sha256:4f1d9991f5acc0ca119f9d443620b77f9d6b33703e51011c16baf57afb285fc6"},
+    {file = "colorama-0.4.6.tar.gz", hash = "sha256:08695f5cb7ed6e0531a20572697297273c47b8cae5a63ffc6d6ed5c201be6e44"},
+]
+
+[[package]]
+name = "fastapi"
+version = "0.115.7"
+description = "FastAPI framework, high performance, easy to learn, fast to code, ready for production"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "fastapi-0.115.7-py3-none-any.whl", hash = "sha256:eb6a8c8bf7f26009e8147111ff15b5177a0e19bb4a45bc3486ab14804539d21e"},
+    {file = "fastapi-0.115.7.tar.gz", hash = "sha256:0f106da6c01d88a6786b3248fb4d7a940d071f6f488488898ad5d354b25ed015"},
+]
+
+[package.dependencies]
+pydantic = ">=1.7.4,<1.8 || >1.8,<1.8.1 || >1.8.1,<2.0.0 || >2.0.0,<2.0.1 || >2.0.1,<2.1.0 || >2.1.0,<3.0.0"
+starlette = ">=0.40.0,<0.46.0"
+typing-extensions = ">=4.8.0"
+
+[package.extras]
+all = ["email-validator (>=2.0.0)", "fastapi-cli[standard] (>=0.0.5)", "httpx (>=0.23.0)", "itsdangerous (>=1.1.0)", "jinja2 (>=3.1.5)", "orjson (>=3.2.1)", "pydantic-extra-types (>=2.0.0)", "pydantic-settings (>=2.0.0)", "python-multipart (>=0.0.18)", "pyyaml (>=5.3.1)", "ujson (>=4.0.1,!=4.0.2,!=4.1.0,!=4.2.0,!=4.3.0,!=5.0.0,!=5.1.0)", "uvicorn[standard] (>=0.12.0)"]
+standard = ["email-validator (>=2.0.0)", "fastapi-cli[standard] (>=0.0.5)", "httpx (>=0.23.0)", "jinja2 (>=3.1.5)", "python-multipart (>=0.0.18)", "uvicorn[standard] (>=0.12.0)"]
+
+[[package]]
+name = "h11"
+version = "0.14.0"
+description = "A pure-Python, bring-your-own-I/O implementation of HTTP/1.1"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "h11-0.14.0-py3-none-any.whl", hash = "sha256:e3fe4ac4b851c468cc8363d500db52c2ead036020723024a109d37346efaa761"},
+    {file = "h11-0.14.0.tar.gz", hash = "sha256:8f19fbbe99e72420ff35c00b27a34cb9937e902a8b810e2c88300c6f0a3b699d"},
+]
+
+[[package]]
+name = "idna"
+version = "3.10"
+description = "Internationalized Domain Names in Applications (IDNA)"
+optional = false
+python-versions = ">=3.6"
+files = [
+    {file = "idna-3.10-py3-none-any.whl", hash = "sha256:946d195a0d259cbba61165e88e65941f16e9b36ea6ddb97f00452bae8b1287d3"},
+    {file = "idna-3.10.tar.gz", hash = "sha256:12f65c9b470abda6dc35cf8e63cc574b1c52b11df2c86030af0ac09b01b13ea9"},
+]
+
+[package.extras]
+all = ["flake8 (>=7.1.1)", "mypy (>=1.11.2)", "pytest (>=8.3.2)", "ruff (>=0.6.2)"]
+
+[[package]]
+name = "loguru"
+version = "0.7.3"
+description = "Python logging made (stupidly) simple"
+optional = false
+python-versions = "<4.0,>=3.5"
+files = [
+    {file = "loguru-0.7.3-py3-none-any.whl", hash = "sha256:31a33c10c8e1e10422bfd431aeb5d351c7cf7fa671e3c4df004162264b28220c"},
+    {file = "loguru-0.7.3.tar.gz", hash = "sha256:19480589e77d47b8d85b2c827ad95d49bf31b0dcde16593892eb51dd18706eb6"},
+]
+
+[package.dependencies]
+colorama = {version = ">=0.3.4", markers = "sys_platform == \"win32\""}
+win32-setctime = {version = ">=1.0.0", markers = "sys_platform == \"win32\""}
+
+[package.extras]
+dev = ["Sphinx (==8.1.3)", "build (==1.2.2)", "colorama (==0.4.5)", "colorama (==0.4.6)", "exceptiongroup (==1.1.3)", "freezegun (==1.1.0)", "freezegun (==1.5.0)", "mypy (==v0.910)", "mypy (==v0.971)", "mypy (==v1.13.0)", "mypy (==v1.4.1)", "myst-parser (==4.0.0)", "pre-commit (==4.0.1)", "pytest (==6.1.2)", "pytest (==8.3.2)", "pytest-cov (==2.12.1)", "pytest-cov (==5.0.0)", "pytest-cov (==6.0.0)", "pytest-mypy-plugins (==1.9.3)", "pytest-mypy-plugins (==3.1.0)", "sphinx-rtd-theme (==3.0.2)", "tox (==3.27.1)", "tox (==4.23.2)", "twine (==6.0.1)"]
+
+[[package]]
+name = "pydantic"
+version = "2.10.6"
+description = "Data validation using Python type hints"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pydantic-2.10.6-py3-none-any.whl", hash = "sha256:427d664bf0b8a2b34ff5dd0f5a18df00591adcee7198fbd71981054cef37b584"},
+    {file = "pydantic-2.10.6.tar.gz", hash = "sha256:ca5daa827cce33de7a42be142548b0096bf05a7e7b365aebfa5f8eeec7128236"},
+]
+
+[package.dependencies]
+annotated-types = ">=0.6.0"
+pydantic-core = "2.27.2"
+typing-extensions = ">=4.12.2"
+
+[package.extras]
+email = ["email-validator (>=2.0.0)"]
+timezone = ["tzdata"]
+
+[[package]]
+name = "pydantic-core"
+version = "2.27.2"
+description = "Core functionality for Pydantic validation and serialization"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "pydantic_core-2.27.2-cp310-cp310-macosx_10_12_x86_64.whl", hash = "sha256:2d367ca20b2f14095a8f4fa1210f5a7b78b8a20009ecced6b12818f455b1e9fa"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-macosx_11_0_arm64.whl", hash = "sha256:491a2b73db93fab69731eaee494f320faa4e093dbed776be1a829c2eb222c34c"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:7969e133a6f183be60e9f6f56bfae753585680f3b7307a8e555a948d443cc05a"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:3de9961f2a346257caf0aa508a4da705467f53778e9ef6fe744c038119737ef5"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:e2bb4d3e5873c37bb3dd58714d4cd0b0e6238cebc4177ac8fe878f8b3aa8e74c"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:280d219beebb0752699480fe8f1dc61ab6615c2046d76b7ab7ee38858de0a4e7"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:47956ae78b6422cbd46f772f1746799cbb862de838fd8d1fbd34a82e05b0983a"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:14d4a5c49d2f009d62a2a7140d3064f686d17a5d1a268bc641954ba181880236"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_aarch64.whl", hash = "sha256:337b443af21d488716f8d0b6164de833e788aa6bd7e3a39c005febc1284f4962"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_armv7l.whl", hash = "sha256:03d0f86ea3184a12f41a2d23f7ccb79cdb5a18e06993f8a45baa8dfec746f0e9"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-musllinux_1_1_x86_64.whl", hash = "sha256:7041c36f5680c6e0f08d922aed302e98b3745d97fe1589db0a3eebf6624523af"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-win32.whl", hash = "sha256:50a68f3e3819077be2c98110c1f9dcb3817e93f267ba80a2c05bb4f8799e2ff4"},
+    {file = "pydantic_core-2.27.2-cp310-cp310-win_amd64.whl", hash = "sha256:e0fd26b16394ead34a424eecf8a31a1f5137094cabe84a1bcb10fa6ba39d3d31"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-macosx_10_12_x86_64.whl", hash = "sha256:8e10c99ef58cfdf2a66fc15d66b16c4a04f62bca39db589ae8cba08bc55331bc"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-macosx_11_0_arm64.whl", hash = "sha256:26f32e0adf166a84d0cb63be85c562ca8a6fa8de28e5f0d92250c6b7e9e2aff7"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:8c19d1ea0673cd13cc2f872f6c9ab42acc4e4f492a7ca9d3795ce2b112dd7e15"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:5e68c4446fe0810e959cdff46ab0a41ce2f2c86d227d96dc3847af0ba7def306"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:d9640b0059ff4f14d1f37321b94061c6db164fbe49b334b31643e0528d100d99"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:40d02e7d45c9f8af700f3452f329ead92da4c5f4317ca9b896de7ce7199ea459"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:1c1fd185014191700554795c99b347d64f2bb637966c4cfc16998a0ca700d048"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d81d2068e1c1228a565af076598f9e7451712700b673de8f502f0334f281387d"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_aarch64.whl", hash = "sha256:1a4207639fb02ec2dbb76227d7c751a20b1a6b4bc52850568e52260cae64ca3b"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_armv7l.whl", hash = "sha256:3de3ce3c9ddc8bbd88f6e0e304dea0e66d843ec9de1b0042b0911c1663ffd474"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-musllinux_1_1_x86_64.whl", hash = "sha256:30c5f68ded0c36466acede341551106821043e9afaad516adfb6e8fa80a4e6a6"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-win32.whl", hash = "sha256:c70c26d2c99f78b125a3459f8afe1aed4d9687c24fd677c6a4436bc042e50d6c"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-win_amd64.whl", hash = "sha256:08e125dbdc505fa69ca7d9c499639ab6407cfa909214d500897d02afb816e7cc"},
+    {file = "pydantic_core-2.27.2-cp311-cp311-win_arm64.whl", hash = "sha256:26f0d68d4b235a2bae0c3fc585c585b4ecc51382db0e3ba402a22cbc440915e4"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-macosx_10_12_x86_64.whl", hash = "sha256:9e0c8cfefa0ef83b4da9588448b6d8d2a2bf1a53c3f1ae5fca39eb3061e2f0b0"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-macosx_11_0_arm64.whl", hash = "sha256:83097677b8e3bd7eaa6775720ec8e0405f1575015a463285a92bfdfe254529ef"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:172fce187655fece0c90d90a678424b013f8fbb0ca8b036ac266749c09438cb7"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:519f29f5213271eeeeb3093f662ba2fd512b91c5f188f3bb7b27bc5973816934"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:05e3a55d124407fffba0dd6b0c0cd056d10e983ceb4e5dbd10dda135c31071d6"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:9c3ed807c7b91de05e63930188f19e921d1fe90de6b4f5cd43ee7fcc3525cb8c"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:6fb4aadc0b9a0c063206846d603b92030eb6f03069151a625667f982887153e2"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:28ccb213807e037460326424ceb8b5245acb88f32f3d2777427476e1b32c48c4"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_aarch64.whl", hash = "sha256:de3cd1899e2c279b140adde9357c4495ed9d47131b4a4eaff9052f23398076b3"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_armv7l.whl", hash = "sha256:220f892729375e2d736b97d0e51466252ad84c51857d4d15f5e9692f9ef12be4"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-musllinux_1_1_x86_64.whl", hash = "sha256:a0fcd29cd6b4e74fe8ddd2c90330fd8edf2e30cb52acda47f06dd615ae72da57"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-win32.whl", hash = "sha256:1e2cb691ed9834cd6a8be61228471d0a503731abfb42f82458ff27be7b2186fc"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-win_amd64.whl", hash = "sha256:cc3f1a99a4f4f9dd1de4fe0312c114e740b5ddead65bb4102884b384c15d8bc9"},
+    {file = "pydantic_core-2.27.2-cp312-cp312-win_arm64.whl", hash = "sha256:3911ac9284cd8a1792d3cb26a2da18f3ca26c6908cc434a18f730dc0db7bfa3b"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-macosx_10_12_x86_64.whl", hash = "sha256:7d14bd329640e63852364c306f4d23eb744e0f8193148d4044dd3dacdaacbd8b"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-macosx_11_0_arm64.whl", hash = "sha256:82f91663004eb8ed30ff478d77c4d1179b3563df6cdb15c0817cd1cdaf34d154"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:71b24c7d61131bb83df10cc7e687433609963a944ccf45190cfc21e0887b08c9"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:fa8e459d4954f608fa26116118bb67f56b93b209c39b008277ace29937453dc9"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:ce8918cbebc8da707ba805b7fd0b382816858728ae7fe19a942080c24e5b7cd1"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:eda3f5c2a021bbc5d976107bb302e0131351c2ba54343f8a496dc8783d3d3a6a"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:bd8086fa684c4775c27f03f062cbb9eaa6e17f064307e86b21b9e0abc9c0f02e"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:8d9b3388db186ba0c099a6d20f0604a44eabdeef1777ddd94786cdae158729e4"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_aarch64.whl", hash = "sha256:7a66efda2387de898c8f38c0cf7f14fca0b51a8ef0b24bfea5849f1b3c95af27"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_armv7l.whl", hash = "sha256:18a101c168e4e092ab40dbc2503bdc0f62010e95d292b27827871dc85450d7ee"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-musllinux_1_1_x86_64.whl", hash = "sha256:ba5dd002f88b78a4215ed2f8ddbdf85e8513382820ba15ad5ad8955ce0ca19a1"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-win32.whl", hash = "sha256:1ebaf1d0481914d004a573394f4be3a7616334be70261007e47c2a6fe7e50130"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-win_amd64.whl", hash = "sha256:953101387ecf2f5652883208769a79e48db18c6df442568a0b5ccd8c2723abee"},
+    {file = "pydantic_core-2.27.2-cp313-cp313-win_arm64.whl", hash = "sha256:ac4dbfd1691affb8f48c2c13241a2e3b60ff23247cbcf981759c768b6633cf8b"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-macosx_10_12_x86_64.whl", hash = "sha256:d3e8d504bdd3f10835468f29008d72fc8359d95c9c415ce6e767203db6127506"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-macosx_11_0_arm64.whl", hash = "sha256:521eb9b7f036c9b6187f0b47318ab0d7ca14bd87f776240b90b21c1f4f149320"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:85210c4d99a0114f5a9481b44560d7d1e35e32cc5634c656bc48e590b669b145"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:d716e2e30c6f140d7560ef1538953a5cd1a87264c737643d481f2779fc247fe1"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:f66d89ba397d92f840f8654756196d93804278457b5fbede59598a1f9f90b228"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:669e193c1c576a58f132e3158f9dfa9662969edb1a250c54d8fa52590045f046"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:9fdbe7629b996647b99c01b37f11170a57ae675375b14b8c13b8518b8320ced5"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d262606bf386a5ba0b0af3b97f37c83d7011439e3dc1a9298f21efb292e42f1a"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_aarch64.whl", hash = "sha256:cabb9bcb7e0d97f74df8646f34fc76fbf793b7f6dc2438517d7a9e50eee4f14d"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_armv7l.whl", hash = "sha256:d2d63f1215638d28221f664596b1ccb3944f6e25dd18cd3b86b0a4c408d5ebb9"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-musllinux_1_1_x86_64.whl", hash = "sha256:bca101c00bff0adb45a833f8451b9105d9df18accb8743b08107d7ada14bd7da"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-win32.whl", hash = "sha256:f6f8e111843bbb0dee4cb6594cdc73e79b3329b526037ec242a3e49012495b3b"},
+    {file = "pydantic_core-2.27.2-cp38-cp38-win_amd64.whl", hash = "sha256:fd1aea04935a508f62e0d0ef1f5ae968774a32afc306fb8545e06f5ff5cdf3ad"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-macosx_10_12_x86_64.whl", hash = "sha256:c10eb4f1659290b523af58fa7cffb452a61ad6ae5613404519aee4bfbf1df993"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-macosx_11_0_arm64.whl", hash = "sha256:ef592d4bad47296fb11f96cd7dc898b92e795032b4894dfb4076cfccd43a9308"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c61709a844acc6bf0b7dce7daae75195a10aac96a596ea1b776996414791ede4"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_armv7l.manylinux2014_armv7l.whl", hash = "sha256:42c5f762659e47fdb7b16956c71598292f60a03aa92f8b6351504359dbdba6cf"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_ppc64le.manylinux2014_ppc64le.whl", hash = "sha256:4c9775e339e42e79ec99c441d9730fccf07414af63eac2f0e48e08fd38a64d76"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_s390x.manylinux2014_s390x.whl", hash = "sha256:57762139821c31847cfb2df63c12f725788bd9f04bc2fb392790959b8f70f118"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:0d1e85068e818c73e048fe28cfc769040bb1f475524f4745a5dc621f75ac7630"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:097830ed52fd9e427942ff3b9bc17fab52913b2f50f2880dc4a5611446606a54"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_aarch64.whl", hash = "sha256:044a50963a614ecfae59bb1eaf7ea7efc4bc62f49ed594e18fa1e5d953c40e9f"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_armv7l.whl", hash = "sha256:4e0b4220ba5b40d727c7f879eac379b822eee5d8fff418e9d3381ee45b3b0362"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-musllinux_1_1_x86_64.whl", hash = "sha256:5e4f4bb20d75e9325cc9696c6802657b58bc1dbbe3022f32cc2b2b632c3fbb96"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-win32.whl", hash = "sha256:cca63613e90d001b9f2f9a9ceb276c308bfa2a43fafb75c8031c4f66039e8c6e"},
+    {file = "pydantic_core-2.27.2-cp39-cp39-win_amd64.whl", hash = "sha256:77d1bca19b0f7021b3a982e6f903dcd5b2b06076def36a652e3907f596e29f67"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_10_12_x86_64.whl", hash = "sha256:2bf14caea37e91198329b828eae1618c068dfb8ef17bb33287a7ad4b61ac314e"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-macosx_11_0_arm64.whl", hash = "sha256:b0cb791f5b45307caae8810c2023a184c74605ec3bcbb67d13846c28ff731ff8"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:688d3fd9fcb71f41c4c015c023d12a79d1c4c0732ec9eb35d96e3388a120dcf3"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:3d591580c34f4d731592f0e9fe40f9cc1b430d297eecc70b962e93c5c668f15f"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:82f986faf4e644ffc189a7f1aafc86e46ef70372bb153e7001e8afccc6e54133"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:bec317a27290e2537f922639cafd54990551725fc844249e64c523301d0822fc"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:0296abcb83a797db256b773f45773da397da75a08f5fcaef41f2044adec05f50"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:0d75070718e369e452075a6017fbf187f788e17ed67a3abd47fa934d001863d9"},
+    {file = "pydantic_core-2.27.2-pp310-pypy310_pp73-win_amd64.whl", hash = "sha256:7e17b560be3c98a8e3aa66ce828bdebb9e9ac6ad5466fba92eb74c4c95cb1151"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_10_12_x86_64.whl", hash = "sha256:c33939a82924da9ed65dab5a65d427205a73181d8098e79b6b426bdf8ad4e656"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-macosx_11_0_arm64.whl", hash = "sha256:00bad2484fa6bda1e216e7345a798bd37c68fb2d97558edd584942aa41b7d278"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_aarch64.manylinux2014_aarch64.whl", hash = "sha256:c817e2b40aba42bac6f457498dacabc568c3b7a986fc9ba7c8d9d260b71485fb"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_17_x86_64.manylinux2014_x86_64.whl", hash = "sha256:251136cdad0cb722e93732cb45ca5299fb56e1344a833640bf93b2803f8d1bfd"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-manylinux_2_5_i686.manylinux1_i686.whl", hash = "sha256:d2088237af596f0a524d3afc39ab3b036e8adb054ee57cbb1dcf8e09da5b29cc"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_aarch64.whl", hash = "sha256:d4041c0b966a84b4ae7a09832eb691a35aec90910cd2dbe7a208de59be77965b"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_armv7l.whl", hash = "sha256:8083d4e875ebe0b864ffef72a4304827015cff328a1be6e22cc850753bfb122b"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-musllinux_1_1_x86_64.whl", hash = "sha256:f141ee28a0ad2123b6611b6ceff018039df17f32ada8b534e6aa039545a3efb2"},
+    {file = "pydantic_core-2.27.2-pp39-pypy39_pp73-win_amd64.whl", hash = "sha256:7d0c8399fcc1848491f00e0314bd59fb34a9c008761bcb422a057670c3f65e35"},
+    {file = "pydantic_core-2.27.2.tar.gz", hash = "sha256:eb026e5a4c1fee05726072337ff51d1efb6f59090b7da90d30ea58625b1ffb39"},
+]
+
+[package.dependencies]
+typing-extensions = ">=4.6.0,<4.7.0 || >4.7.0"
+
+[[package]]
+name = "python-dotenv"
+version = "1.0.1"
+description = "Read key-value pairs from a .env file and set them as environment variables"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "python-dotenv-1.0.1.tar.gz", hash = "sha256:e324ee90a023d808f1959c46bcbc04446a10ced277783dc6ee09987c37ec10ca"},
+    {file = "python_dotenv-1.0.1-py3-none-any.whl", hash = "sha256:f7b63ef50f1b690dddf550d03497b66d609393b40b564ed0d674909a68ebf16a"},
+]
+
+[package.extras]
+cli = ["click (>=5.0)"]
+
+[[package]]
+name = "sniffio"
+version = "1.3.1"
+description = "Sniff out which async library your code is running under"
+optional = false
+python-versions = ">=3.7"
+files = [
+    {file = "sniffio-1.3.1-py3-none-any.whl", hash = "sha256:2f6da418d1f1e0fddd844478f41680e794e6051915791a034ff65e5f100525a2"},
+    {file = "sniffio-1.3.1.tar.gz", hash = "sha256:f4324edc670a0f49750a81b895f35c3adb843cca46f0530f79fc1babb23789dc"},
+]
+
+[[package]]
+name = "starlette"
+version = "0.45.3"
+description = "The little ASGI library that shines."
+optional = false
+python-versions = ">=3.9"
+files = [
+    {file = "starlette-0.45.3-py3-none-any.whl", hash = "sha256:dfb6d332576f136ec740296c7e8bb8c8a7125044e7c6da30744718880cdd059d"},
+    {file = "starlette-0.45.3.tar.gz", hash = "sha256:2cbcba2a75806f8a41c722141486f37c28e30a0921c5f6fe4346cb0dcee1302f"},
+]
+
+[package.dependencies]
+anyio = ">=3.6.2,<5"
+
+[package.extras]
+full = ["httpx (>=0.27.0,<0.29.0)", "itsdangerous", "jinja2", "python-multipart (>=0.0.18)", "pyyaml"]
+
+[[package]]
+name = "typing-extensions"
+version = "4.12.2"
+description = "Backported and Experimental Type Hints for Python 3.8+"
+optional = false
+python-versions = ">=3.8"
+files = [
+    {file = "typing_extensions-4.12.2-py3-none-any.whl", hash = "sha256:04e5ca0351e0f3f85c6853954072df659d0d13fac324d0072316b67d7794700d"},
+    {file = "typing_extensions-4.12.2.tar.gz", hash = "sha256:1a7ead55c7e559dd4dee8856e3a88b41225abfe1ce8df57b7c13915fe121ffb8"},
+]
+
+[[package]]
+name = "uvicorn"
+version = "0.34.0"
+description = "The lightning-fast ASGI server."
+optional = false
+python-versions = ">=3.9"
+files = [
+    {file = "uvicorn-0.34.0-py3-none-any.whl", hash = "sha256:023dc038422502fa28a09c7a30bf2b6991512da7dcdb8fd35fe57cfc154126f4"},
+    {file = "uvicorn-0.34.0.tar.gz", hash = "sha256:404051050cd7e905de2c9a7e61790943440b3416f49cb409f965d9dcd0fa73e9"},
+]
+
+[package.dependencies]
+click = ">=7.0"
+h11 = ">=0.8"
+
+[package.extras]
+standard = ["colorama (>=0.4)", "httptools (>=0.6.3)", "python-dotenv (>=0.13)", "pyyaml (>=5.1)", "uvloop (>=0.14.0,!=0.15.0,!=0.15.1)", "watchfiles (>=0.13)", "websockets (>=10.4)"]
+
+[[package]]
+name = "win32-setctime"
+version = "1.2.0"
+description = "A small Python utility to set file creation time on Windows"
+optional = false
+python-versions = ">=3.5"
+files = [
+    {file = "win32_setctime-1.2.0-py3-none-any.whl", hash = "sha256:95d644c4e708aba81dc3704a116d8cbc974d70b3bdb8be1d150e36be6e9d1390"},
+    {file = "win32_setctime-1.2.0.tar.gz", hash = "sha256:ae1fdf948f5640aae05c511ade119313fb6a30d7eabe25fef9764dca5873c4c0"},
+]
+
+[package.extras]
+dev = ["black (>=19.3b0)", "pytest (>=4.6.2)"]
+
+[metadata]
+lock-version = "2.0"
+python-versions = "3.12.*"
+content-hash = "347e22360bbf6bffd7da2466e4c3ef4ec5d60bbc03a8257b64ce72165f7653e7"

pyproject.toml

@@ -0,0 +1,19 @@
+[tool.poetry]
+name = "proposal-generator"
+version = "0.1.0"
+description = ""
+authors = ["Kanha Upadhyay <kanha.upadhyay@sifars.com>"]
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "3.12.*"
+fastapi = "^0.115.7"
+uvicorn = "^0.34.0"
+loguru = "^0.7.3"
+python-dotenv = "^1.0.1"
+aiosmtplib = "^3.0.2"
+
+
+[build-system]
+requires = ["poetry-core"]
+build-backend = "poetry.core.masonry.api"

src/__init__.py

@@ -0,0 +1,29 @@
+import os
+
+from dotenv import load_dotenv
+
+from .app import app
+
+load_dotenv()
+
+if not os.getenv("SMTP_SERVER"):
+    raise ValueError("SMTP_SERVER environment not set.")
+
+if not os.getenv("SMTP_PORT"):
+    raise ValueError("SMTP_PORT environment not set.")
+
+if not os.getenv("SMTP_USERNAME"):
+    raise ValueError("SMTP_USERNAME environment not set.")
+
+if not os.getenv("SMTP_PASSWORD"):
+    raise ValueError("SMTP_PASSWORD environment not set.")
+
+if not os.getenv("SENDER_EMAIL"):
+    raise ValueError("SENDER_EMAIL environment not set.")
+
+if not os.getenv("RECIPIENT_EMAIL"):
+    raise ValueError("RECIPIENT_EMAIL environment not set.")
+
+__all__ = ["app"]
+__version__ = "0.1.0"
+__author__ = "Kanha Upadhyay"

src/app.py

@@ -0,0 +1,71 @@
+import os
+import re
+import tempfile
+
+from fastapi import FastAPI, HTTPException
+from pydantic import BaseModel
+
+from src.utils import EmailClient
+
+app = FastAPI()
+
+TEMPLATE = ""
+with open("src/proposal_template.md", "r") as file:
+    TEMPLATE = file.read()
+
+TEMPLATE = TEMPLATE.replace("`", "")
+VARIABLES = re.findall(r"\{(.*?)\}", TEMPLATE)
+
+
+class ProposalRequest(BaseModel):
+    project_name: str
+    project_overview: str
+    project_introduction: str
+    about_us: str
+    background_of_the_project: str
+    scope_of_work: str
+    technical_approach: str
+    deployment_and_integration: str
+    timeline: str
+    team_structure: str
+    platform: str
+    licensing_model: str
+    risk_analysis: str
+    past_projects: str
+
+
+async def generate_proposal(data: dict):
+    proposal = TEMPLATE
+    for variable in VARIABLES:
+        proposal = proposal.replace(
+            f"{{{variable}}}",
+            data.get(variable, f"DATA NOT FOUND FOR {variable}. FIXME."),
+        )
+    with tempfile.NamedTemporaryFile(delete=False, suffix=".md") as temp_file:
+        temp_file.write(proposal.encode())
+        attachments = [temp_file.name]
+        recipient_email = os.getenv("RECIPIENT_EMAIL")
+        subject = f"Proposal for {data.get('project_name')}"
+        body = f"Hello,\n\nPlease find the proposal attached.\n\nBest,\nProposal Bot"
+        async with EmailClient() as email_client:
+            await email_client.send_email(
+                subject=subject,
+                body=body,
+                to_emails=[recipient_email],
+                attachments=attachments,
+            )
+    return {"message": "Proposal sent successfully"}
+
+
+@app.get("/")
+async def check_health():
+    return {"response": "Service is healthy!"}
+
+
+@app.post("/proposals/")
+async def generate_proposal_endpoint(request: ProposalRequest):
+    try:
+        proposal = await generate_proposal(data=request.model_dump())
+        return {"proposal": proposal}
+    except Exception as e:
+        raise HTTPException(status_code=500, detail=f"{e}")

src/proposal_template.md

@@ -0,0 +1,167 @@
+# `{project_name}` Proposal
+
+## Table of Contents
+
+| Section                                                          |
+| ---------------------------------------------------------------- |
+| [Introduction](#1-introduction)                                  |
+| [Project Timeline and Pricing](#2-project-timeline--pricing)     |
+| [Platform](#3-platform)                                          |
+| [Licensing Model](#4-licensing-model)                            |
+| [Risk Analysis](#5-risk-analysis)                                |
+| [Past Projects](#6-past-projects)                                |
+| [Service Level Matrix](#7-service-level-matrix)                  |
+| [Future Requirements](#8-future-requirements)                    |
+| [Ownership](#9-ownership)                                        |
+| [Additional Information](#10-additional-information)             |
+| [Dependencies and Assumptions](#11-dependencies-and-assumptions) |
+| [Change Management](#12-change-management)                       |
+| [Terms and Conditions](#13-terms--conditions)                    |
+| [Estimation Disclaimer](#14-estimation-disclaimer)               |
+
+# 1. Introduction
+
+### Company Overview
+
+Sifars is pleased to present a comprehensive proposal for the development and implementation of the `{project_name}`. As a leading provider of innovative software solutions, Sifars brings a wealth of experience and expertise to this project. With a proven track record of delivering tailored solutions that address our clients' unique needs, we are confident in our ability to successfully execute this project and exceed expectations.
+
+### Project Overview
+
+`{project_overview}`
+
+### Inroduction
+
+`{project_introduction}`
+
+### About Us
+
+`{about_us}`
+
+### Background of the Project
+
+`{background_of_the_project}`
+
+### Scope of Work
+
+`{scope_of_work}`
+
+### Technical Approach
+
+`{technical_approach}`
+
+### Deployment and Integration
+
+`{deployment_and_integration}`
+
+# 2. Project Timeline & Pricing
+
+The successful implementation of the `{project_name}` will follow a structured timeline, ensuring timely delivery of milestones and alignment with project objectives. Below is the proposed timeline outlining key milestones and their respective durations.
+
+Efforts (Man Days): The number of days it will take for a single person to deliver the milestone, with a working day consisting of 8 hours.
+
+Time (Days): The duration required for our team to deliver the milestone, considering a working day of 8 hours and involving multiple team members.
+
+### Timeline
+
+`{timeline}`
+
+| S.No. | Milestone                    | Efforts (ManDays) | Time (Days) | Price |
+| ----- | ---------------------------- | ----------------- | ----------- | ----- |
+| 1     | High-Level Design Document   |                   |             |       |
+| 2     | Low-Level Design Document    |                   |             |       |
+| 3     | Proof of Concept             |                   |             |       |
+| 4     | Minimum Viable Product (MVP) |                   |             |       |
+| 5     | Release of Application       |                   |             |       |
+|       | **Total**                    |                   |             |       |
+
+### Team Structure
+
+`{team_structure}`
+
+# 3. Platform
+
+`{platform}`
+
+# 4. Licensing Model
+
+`{licensing_model}`
+
+As the project progresses and potential additional tools or services are incorporated, there may be further licensing considerations based on specific needs and agreements with respective vendors. Therefore, the Licensing Model for the project will evolve accordingly to accommodate any future requirements and ensure compliance with all relevant licenses and regulations.
+
+# 5. Risk Analysis
+
+`{risk_analysis}`
+
+# 6. Past Projects
+
+`{past_projects}`
+
+# 7. Service Level Matrix
+
+Respond to service-related incidents submitted by customers within the following time frames. Please note that these only cover any bugs or service-related incidents. In case, there is a major change/upgrade required such as training the AI models on new data, or improving performance, we would need to set up a separate contract for it.
+
+We provide one-month complimentary support once the project concludes.
+
+| Severity Level   | Description of risk level                                                                                                                                                                                                                        | Maximu m respons e time | Maximum solution to the problem |
+| ---------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | ----------------------- | ------------------------------- |
+| Level One (S1)   | 1. Severe problems that cause the system to stop functioning, preventing users from interacting with the system. 2. There is a problem that causes an error in the validity or accuracy of the data processed by the system.                     | 1 hour                  | 2 hour                          |
+| Level Two (S2)   | 1. There is a highly important problem that affects the workflow in the system, but does not stop or prevent the completion of interactions and does not affect the validity or accuracy of the data.                                            | 4 hours                 | 1 day                           |
+| Level Three (S3) | 1. There is a problem of moderate importance that does not affect the functioning of the system. 2. It stops or prevents the completion of the interaction but does not affect the validity or accuracy of the data and has no financial impact. | 2 days                  | 5 days                          |
+| Level Four (S4)  | 1. The presence of a minor problem related to cosmetic matters helps improve a user’s interaction with the system. 2. Or need to improve the overall accuracy of the system                                                                      | 5 days                  | 10 days                         |
+
+# 8. Future Requirements
+
+We understand the importance of futureproofing your investment in the `{project_name}`, and we're committed to ensuring that the solution remains adaptable and scalable to meet your evolving needs. As part of our development approach, we'll build the system with modularity and flexibility in mind, allowing for seamless integration of new features and enhancements as your requirements change over time.
+
+1. Scalability: As your organization grows or your `{project_name}` needs expand, the system should be able to accommodate increased user loads and data volumes without sacrificing performance. We'll design the architecture with scalability in mind, utilizing cloud technologies or scalable infrastructure where applicable.
+2. Customization: Your workflows and processes may evolve over time, necessitating customizations or additional features within the system. We'll ensure that the architecture supports easy customization and extension, allowing for the incorporation of new modules or functionality as needed.
+3. Integration: As your IT ecosystem evolves, you may require integration with other systems or platforms to streamline operations and improve data flow. We'll design the system with integration capabilities, making it easier to connect with third-party applications such as CRM systems, accounting software, or external databases.
+
+Throughout our partnership, we'll maintain open lines of communication to discuss your evolving needs and explore opportunities for further development. Our goal is to build a long-term partnership focused on delivering solutions that drive your organization's success.
+
+# 9. Ownership
+
+Ensuring clear ownership of the source code is a crucial aspect of our partnership. We believe in transparency and empowering our clients with full control over their intellectual property. Upon completion of the project and full payment of fees, you will retain full ownership of the source code developed for the `{project_name}`. This means you will have the right to modify, enhance, and distribute the code as you see fit without any restrictions from our end. In addition to providing you with the source code, we will also document the architecture, design decisions, and any relevant technical documentation to facilitate future maintenance and development efforts. Our goal is to ensure that you have the necessary resources and knowledge to independently manage and evolve the system over time. Furthermore, we're committed to fostering a collaborative relationship where you have the freedom to engage with other vendors or developers for ongoing support or further enhancements if desired. We believe in building long-term partnerships based on trust, mutual respect, and a shared commitment to your success.
+
+# 10. Additional Information
+
+In addition to the technical aspects mentioned above, there are several other factors worth considering ensuring the success and smooth execution of the `{project_name}` development
+
+- **Data Migration and Integration:** If you're migrating from an existing system or integrating with other platforms, careful planning and execution are required to ensure seamless data migration and integration. We'll work closely with your team to assess data requirements, identify any potential challenges, and develop a strategy to mitigate risks. This process may necessitate substantial effort and expenditure beyond the proposed budget.
+- **Regulatory Compliance:** Depending on your industry and geographic location, there may be specific regulatory requirements that the `{project_name}` needs to comply with. It's important to factor in compliance considerations from the outset to avoid costly delays or setbacks later. It's crucial that you inform us about any regulatory requirements upfront.
+
+# 11. Dependencies and Assumptions
+
+- **Third-Party API Integration:** To enhance functionality, we may require third-party integrations. We'll request access to necessary accounts for these integrations from the client during the development process to ensure seamless implementation and operation.
+- **Environment Access:** Access to development, testing, and production environments is assumed throughout the project. The client will provide necessary infrastructure resources such as servers and domains for setting up these environments.
+
+# 12. Change Management
+
+- **What is a change request** - A change request is a proposal to alter a product or system, often brought up by the client or another team member. During a project, this can happen when a client wants to change or alter the agreed upon deliverables.
+- **Change requests** - can also be initiated internally as well and can include things like changing or upgrading software. In general, there are two types of change requests: those that are within the scope and those that are outside the scope of the project.
+- **Within the scope** – change requests that are inside the scope involve small corrections to an existing requirement. They usually have minimal impact on the budget or the rest of the team.
+- **Outside the scope** – on the other hand, change requests that are outside the scope take a considerable amount of time to implement and have a more sizable impact on the budget. Change requests must be dealt with in an appropriate and timely manner.
+
+# 13. Terms & Conditions
+
+- The scope will be contained to the line items mentioned in milestones. While creating the proposal, it has been assumed that the requirements given by the client form the complete scope of the application. Any requirement, not explicitly mentioned in this document, does not form a part of this estimate.
+- Client shall provide all third-party software and hardware components. This includes hosting details, hardware environment etc. The cost of all these components will be borne by the client and does not form the part of the proposed estimated cost.
+- If required, the client shall provide all the test data to run the test cases. The client shall be available to solve the queries, which the development team may have, to ensure that project timelines are met.
+- Client shall perform timely review of the deliveries, as per the schedule of deliveries defined at the project initiation. Any delays from the client end would lead to subsequent delays in development of the project, which will be communicated at that time itself.
+- All quotations and estimates provided by Sifars are valid for a period of 30 days from the date of issue. Quotations not accepted within this timeframe need to be re-issued.
+- Upon acceptance, Sifars will perform the services described in the quotation. Any additional services that are later requested by the client and/or not defined under the scope-of-work in this quotation may incur additional charges.
+- The services will be completed, and/or delivery of products will be made according to the estimated timeline, agreed upon mutually by both parties. Sifars reserves the right to modify timelines in response to unforeseen circumstances or changes in project requirements.
+- Changes to the delivery and performance of any products or services, including quantity, specifications, and scheduling, do not become binding until approved in writing by both parties. Any changes may result in additional or increased charges.
+- All information related to the project will be considered confidential, and may only be released if necessary after mutual approval by the client and Sifars.
+- Once the project formally starts, the client or Sifars may terminate the agreement at any time by providing written notice via email or certified mail to the other party. In the event of termination, Sifars may issue a final invoice according to terms of the contract for any unbilled time or work.
+- An advance payment of 10% of the proposed project cost is to be made before the first milestone. This will be adjusted towards the last milestone/deliverable.
+- Each milestone’s payment will be made after the completion.
+- Payment terms will be NET15.
+
+# 14. Estimation Disclaimer
+
+This proposal provides a time and cost estimate based on a range of days required to complete the project. These estimates are derived from initial discussions and assumptions about the project scope. While we strive for accuracy, it's important to note that software development inherently involves many variables and unforeseen complexities. As such, this estimate cannot be 100% precise. However, we have a high degree of confidence that the final cost will remain within the provided estimate.
+
+Once the low-level design document of the project is ready, we will revisit the pricing, allowing us to refine our estimates and provide a more accurate projection. This detailed document will be exceptionally valuable, as it surfaces all the essential questions and details about the project, ensuring that every aspect is thoroughly understood and planned for.
+
+Engaging in this comprehensive estimation process not only helps us deliver a realistic understanding of the project's timeline and budget but also provides you with valuable insights into the project's development phases. This empowers you to make informed decisions, ensuring the best use of your resources and investments.

src/utils/__init__.py

@@ -0,0 +1,5 @@
+from ._email_client import EmailClient
+
+__all__ = ["EmailClient"]
+__version__ = "0.1.0"
+__author__ = "Kanha Upadhyay"

src/utils/_email_client.py

@@ -0,0 +1,50 @@
+import os
+from email.message import EmailMessage
+
+import aiosmtplib
+
+
+class EmailClient:
+    def __init__(self):
+        self.smtp_server = os.getenv("SMTP_SERVER")
+        self.smtp_port = int(os.getenv("SMTP_PORT"))
+        self.username = os.getenv("SMTP_USERNAME")
+        self.password = os.getenv("SMTP_PASSWORD")
+
+    async def __aenter__(self):
+        return self
+
+    async def __aexit__(self, exc_type, exc, tb):
+        pass
+
+    async def send_email(
+        self,
+        subject: str,
+        body: str,
+        to_emails: list,
+        attachments: list = None,
+    ):
+        message = EmailMessage()
+        message["From"] = os.getenv("SENDER_EMAIL")
+        message["To"] = ", ".join(to_emails)
+        message["Subject"] = subject
+        message.set_content(body)
+        if attachments:
+            for attachment in attachments:
+                with open(attachment, "rb") as file:
+                    file_data = file.read()
+                    file_name = file.name
+                message.add_attachment(
+                    file_data,
+                    maintype="application",
+                    subtype="octet-stream",
+                    filename=file_name,
+                )
+        await aiosmtplib.send(
+            message,
+            hostname=self.smtp_server,
+            port=self.smtp_port,
+            username=self.username,
+            password=self.password,
+            start_tls=True,
+        )