finalized design; reset version number; here goes

.env.example

@@ -0,0 +1,15 @@
+# fastapi
+API_ENDPOINT=http://localhost:8000/chat
+
+# openai
+OPENAI_API_KEY=
+
+# discord
+SCINT_DISCORD_TOKEN=
+
+# openweather
+OPENWEATHER_API_KEY=
+
+# google cse
+GOOGLE_API_KEY=
+CUSTOM_SEARCH_ID=

.github/workflows/codeql.yml

@@ -0,0 +1,82 @@
+# For most projects, this workflow file will not need changing; you simply need
+# to commit it to your repository.
+#
+# You may wish to alter this file to override the set of languages analyzed,
+# or to provide custom queries or build logic.
+#
+# ******** NOTE ********
+# We have attempted to detect the languages in your repository. Please check
+# the `language` matrix defined below to confirm you have the correct set of
+# supported CodeQL languages.
+#
+name: "CodeQL"
+
+on:
+  push:
+    branches: [ "main" ]
+  pull_request:
+    # The branches below must be a subset of the branches above
+    branches: [ "main" ]
+  schedule:
+    - cron: '22 6 * * 1'
+
+jobs:
+  analyze:
+    name: Analyze
+    # Runner size impacts CodeQL analysis time. To learn more, please see:
+    #   - https://gh.io/recommended-hardware-resources-for-running-codeql
+    #   - https://gh.io/supported-runners-and-hardware-resources
+    #   - https://gh.io/using-larger-runners
+    # Consider using larger runners for possible analysis time improvements.
+    runs-on: ${{ (matrix.language == 'swift' && 'macos-latest') || 'ubuntu-latest' }}
+    timeout-minutes: ${{ (matrix.language == 'swift' && 120) || 360 }}
+    permissions:
+      actions: read
+      contents: read
+      security-events: write
+
+    strategy:
+      fail-fast: false
+      matrix:
+        language: [ 'python' ]
+        # CodeQL supports [ 'cpp', 'csharp', 'go', 'java', 'javascript', 'python', 'ruby', 'swift' ]
+        # Use only 'java' to analyze code written in Java, Kotlin or both
+        # Use only 'javascript' to analyze code written in JavaScript, TypeScript or both
+        # Learn more about CodeQL language support at https://aka.ms/codeql-docs/language-support
+
+    steps:
+    - name: Checkout repository
+      uses: actions/checkout@v3
+
+    # Initializes the CodeQL tools for scanning.
+    - name: Initialize CodeQL
+      uses: github/codeql-action/init@v2
+      with:
+        languages: ${{ matrix.language }}
+        # If you wish to specify custom queries, you can do so here or in a config file.
+        # By default, queries listed here will override any specified in a config file.
+        # Prefix the list here with "+" to use these queries and those in the config file.
+
+        # For more details on CodeQL's query packs, refer to: https://docs.github.com/en/code-security/code-scanning/automatically-scanning-your-code-for-vulnerabilities-and-errors/configuring-code-scanning#using-queries-in-ql-packs
+        # queries: security-extended,security-and-quality
+
+
+    # Autobuild attempts to build any compiled languages (C/C++, C#, Go, Java, or Swift).
+    # If this step fails, then you should remove it and run the build manually (see below)
+    - name: Autobuild
+      uses: github/codeql-action/autobuild@v2
+
+    # ℹ️ Command-line programs to run using the OS shell.
+    # 📚 See https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#jobsjob_idstepsrun
+
+    #   If the Autobuild fails above, remove it and uncomment the following three lines.
+    #   modify them (or add more) to build your code if your project, please refer to the EXAMPLE below for guidance.
+
+    # - run: |
+    #     echo "Run, Build Application using script"
+    #     ./location_of_script_within_repo/buildscript.sh
+
+    - name: Perform CodeQL Analysis
+      uses: github/codeql-action/analyze@v2
+      with:
+        category: "/language:${{matrix.language}}"

.gitignore

@@ -103,6 +103,8 @@ ENV/
 
 # IDE settings
 .vscode/
+.zed/
+.cursorignore
 
 # macOS
 

LICENSE

@@ -0,0 +1,9 @@
+MIT License
+
+Copyright (c) 2023 Tim Kaechle
+
+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.

README.md

@@ -1,12 +1,37 @@
-# Scint Search
+# Scint
 
-``` bash
+```bash
 poetry install
 tailwindcss -i static/styles/tailwind.css -o static/styles/index.css --watch &
 poetry run uvicorn app:main --reload --reload-dir=templates --reload-dir=static
 ```
 
-```
-redis-stack-server
-redisinsight
-```
+### Capabilities:
+
+-   **Message Processing**: The system can receive and process messages, executing a series of tools and subprocesses to generate responses.
+-   **Dynamic Tool Utilization**: Tools such as `Assert`, [Validate](file:///Users/kaechle/Developer/projects/scint/scint/processes/analysis.py#34%2C7-34%2C7), and `Pass` provide functionalities like assertion checking, validation of process results, and conditional execution flow.
+-   **Subprocess Management**: The [Main](file:///Users/kaechle/Developer/projects/scint/scint/components/process.py#84%2C35-84%2C35) process can manage subprocesses, such as the [Chat](file:///Users/kaechle/Developer/projects/scint/scint/processes/messaging.py#66%2C7-66%2C7) process, to handle specific tasks.
+-   **Streaming Responses**: The system can stream responses back to the client, enhancing real-time interaction capabilities.
+-   **Execution Mapping**: It supports building execution maps, potentially for visualization or debugging of process flows.
+
+### Architecture:
+
+-   **Process-Based Design**: The system is structured around [Process](file:///Users/kaechle/Developer/projects/scint/scint/processes/status.py#3%2C40-3%2C40) and [Tool](file:///Users/kaechle/Developer/projects/scint/scint/processes/status.py#4%2C37-4%2C37) classes, where each process can utilize multiple tools and include subprocesses, forming a hierarchical execution model.
+-   **Component Modularity**: Components like [models](file:///Users/kaechle/Developer/projects/scint/scint/processes/status.py#2%2C25-2%2C25), [config](file:///Users/kaechle/Developer/projects/scint/scint/processes/transform.py#39%2C6-39%2C6), and [utils](file:///Users/kaechle/Developer/projects/scint/scint/components/process.py#10%2C14-10%2C14) provide foundational functionalities such as message modeling, configuration management, and utility functions, promoting code reuse and modularity.
+-   **Asynchronous Execution**: Many functions are designed to be asynchronous (`async def`), indicating the system is built to handle concurrent operations efficiently, suitable for I/O-bound tasks like network communication.
+-   **Dependency Injection**: Usage of `injector` module suggests a dependency injection pattern, facilitating loose coupling between components and making the system more flexible and testable.
+
+### Potential:
+
+-   **Scalability**: The asynchronous nature and modular design allow for scalability, both in terms of handling a large number of concurrent requests and in extending the system with new functionalities.
+-   **Customizability**: The clear separation between processes and tools, along with configurable presets and properties, makes the system highly customizable to different use cases.
+-   **Integration Capabilities**: Constants for external APIs and a structure that supports dynamic tooling indicate potential for integration with external services and APIs, expanding its capabilities.
+-   **Real-time Interaction**: The streaming response mechanism can be leveraged for real-time applications, such as chatbots or live data processing systems.
+
+### Example Enhancements:
+
+-   **Adding New Tools and Processes**: New tools and processes can be easily added to extend the system's capabilities, such as integrating natural language processing or machine learning models for more advanced analysis and responses.
+-   **Improving User Interaction**: Enhancements to the user interface, such as adding websockets for full-duplex communication, could improve user interaction for real-time applications.
+-   **Performance Optimization**: Profiling and optimizing the asynchronous execution flow and subprocess management could further improve performance, especially under high load.
+
+In summary, the system presents a robust foundation for building complex, process-oriented applications with a focus on message processing and response generation, offering scalability, customizability, and integration capabilities.