mindroot 9.11.0__py3-none-any.whl → 9.12.0__py3-none-any.whl

mindroot/docs/data/preferred_models.json

@@ -0,0 +1,12 @@
+[
+    {
+        "service_or_command_name": "stream_chat",
+        "flag": "no_flags",
+        "model": "claude-3-5-sonnet-20241022"
+    },
+    {
+        "service_or_command_name": "stream_chat",
+        "flag": "uncensored",
+        "model": "llama-3.1-405b-instruct"
+    }
+]

mindroot/docs/data/providers.json

@@ -0,0 +1,62 @@
+[
+  {
+    "name": "OpenAI (AH)",
+    "local": false,
+    "plugin": "ah_openai",
+    "models": [ 
+      {
+        "name": "gpt-4o",
+        "provider_model_name": "gpt-4o",
+        "meta": { "input_price_per_1M": 5.00, "output_price_per_1M": 15.00 },
+        "services": ["stream_chat"],
+        "commands": [],
+        "available": true
+      }
+    ]
+  },
+  {
+    "name": "Anthropic (AH)",
+    "local": false,
+    "plugin": "ah_anthropic",
+    "models": [ 
+      {
+        "name": "claude-3-5-sonnet-20240620",
+        "provider_model_name": "claude-3-5-sonnet-20240620",
+        "meta": { "input_price_per_1M": 3.00, "output_price_per_1M": 15.00 },
+        "services": ["stream_chat"],
+        "commands": [],
+        "available": true
+      }
+    ]
+  },
+  {
+    "name": "ollama (AH)",
+    "local": true,
+    "plugin": "ah_ollama",
+    "models": [ 
+      {
+        "name": "llama3-8b-instruct",
+        "provider_model_name": "llama3:8b",
+        "meta": { "input_price_per_1M": 0.00, "output_price_per_1M": 0.00 },
+        "services": ["stream_chat"],
+        "commands": [],
+        "available": false
+      }
+    ]
+  },
+  {
+    "name": "together.ai (AH)",
+    "local": false,
+    "plugin": "ah_togetherai",
+    "models": [ 
+      {
+        "name": "llama3-70b-instruct",
+        "provider_model_name": "meta-llama/Llama-3-70b-chat-hf",
+        "meta": { "input_price_per_1M": 0.90, "output_price_per_1M": 0.90 },
+        "services": ["stream_chat"],
+        "commands": [],
+        "available": true
+      }
+    ]
+  }
+]

mindroot/docs/developer_documentation.rst

@@ -0,0 +1,26 @@
+Developer Documentation
+=======================
+
+This section contains documentation for developers working with MindRoot.
+
+.. todo:: Add developer documentation content here
+
+API Reference
+-------------
+
+.. todo:: Add API reference documentation
+
+Plugin Development
+------------------
+
+.. todo:: Add plugin development guide
+
+Contributing
+------------
+
+.. todo:: Add contribution guidelines
+
+Architecture
+------------
+
+.. todo:: Add system architecture overview

mindroot/docs/getting_started.rst

@@ -0,0 +1,139 @@
+Getting Started
+===============
+
+If MindRoot is already installed and running, skip to `LLM Plugin Installation`_.
+If using pre-configured MindRoot hosting, skip to `LLM API Key`_.
+
+.. todo:: Add getting started content here
+
+Installation
+------------
+
+Usually you need to create a python virtual environment:
+
+``python -m venv .venv``
+
+And activate:
+
+``source .venv/bin/activate``
+
+Then just install with pip:
+
+``pip install mindroot``
+
+Starting MindRoot
+-----------------
+
+The first time you can specify the admin user and password:
+
+``mindroot -u admin -pw password``
+
+The server defaults to `http://0.0.0.0:8010/ <http://0.0.0.0:8010/>`_ .
+You will need to log in.
+
+LLM Plugin Installation
+-----------------------
+
+- Go to the `/admin` page by clicking the Admin link at the top of the home page.
+
+- Go to the Install/Registry tab
+
+- Search for 'OpenRouter' and click Install next to the result that comes up.
+
+.. image:: installopenrouter.png
+
+- A dialog will show the log of the installation.
+
+- Restart: Server Settings | Server Control | Restart
+
+.. image:: restart.png
+
+
+If you want, you can make sure the OpenRouter Plugin is installed:
+
+- Go to the /admin page (Admin link on home page)
+
+- Expand the Advanced section and click on Plugins
+
+- OpenRouter/ah_openrouter should show up
+
+.. image:: openrouter.png
+
+LLM API Key
+-----------
+
+For this section you will need an API key from an LLM provider.
+We will assume OpenRouter for this example.
+
+Now, enter your `OpenRouter API key <https://openrouter.ai/settings/keys>`_:
+
+- Go to `/admin` (Admin link on home page) Advanced | Environment Variables
+
+.. image:: envvar.png
+
+- Find the ah_openrouter section and the `OPENROUTER_KEY` field; click Edit.
+
+- Enter your key and press Save.
+
+Finally, restart MindRoot:
+
+- Go to Admin | Server Settings |  Server Control 
+- Click on Restart Server
+
+.. image:: restart.png
+
+Chat with Assistant
+-------------------
+
+- On the home page, click the Assistant button.
+
+- A new tab will open with a chat UI.
+
+- Try requesting something from the assistant, for example:
+
+  "Create a mood tracker table showing daily activities with emoji ratings and star scores for each day of the work week."
+
+.. image:: mood.png
+
+(Note: shown is typical output from DeepSeek Chat 3.1)
+
+Install Plugins with Tools
+--------------------------
+
+(Note: if you are using MindRoot hosting, these tools are already installed).
+
+- Go to Admin | Install/Registry
+
+- Install the runvnc/ah_shell and runvnc/ah_files plugins:
+
+- Click on Plugins.
+
+- Enter e.g. "Files" in the Search input
+
+.. image:: files.png
+
+- Click Install
+
+- Repeat for Shell (execute commands)
+
+- Restart MindRoot:
+
+- Go to Admin | Server Settings |  Server Control
+- Click on Restart Server
+
+.. image:: restart.png
+
+Give Assistant a Programming Task
+---------------------------------
+
+- On the home page, click the Assistant button to open a new chat.
+
+- "Create a simple but beautiful web page about the phases of the moon. Save to ./imgs/moon.html and provide a clickable link to /imgs/moon.html"
+
+.. image:: moon.png
+
+(Note: shown is typical output from DeepSeek Chat 3.1)
+
+
+
+

mindroot/docs/index.rst

@@ -0,0 +1,38 @@
+.. MindRoot documentation master file, created by
+   sphinx-quickstart on Sat Aug 23 15:52:37 2025.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+MindRoot Documentation
+======================
+
+Welcome to the MindRoot documentation. This documentation is divided into two main sections:
+
+- **User Documentation**: For end users who want to install, configure, and use MindRoot
+- **Developer Documentation**: For developers who want to extend, contribute to, or understand MindRoot's architecture
+
+.. toctree::
+   :maxdepth: 2
+   :caption: User Documentation:
+
+   user_documentation
+
+.. toctree::
+   :maxdepth: 2
+   :caption: Developer Documentation:
+
+   developer_documentation
+   modules
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+View Source Code
+================
+
+* :ref:`viewcode`
+* `Browse source code <_sources/>`_

mindroot/docs/install_plugins_with_tools.rst

@@ -0,0 +1,25 @@
+Install Plugins with Tools
+==========================
+
+(Note: if you are using MindRoot hosting, these tools are already installed).
+
+- Go to Admin | Install/Registry
+
+- Install the runvnc/ah_shell and runvnc/ah_files plugins:
+
+- Click on Plugins.
+
+- Enter e.g. "Files" in the Search input
+
+.. image:: files.png
+
+- Click Install
+
+- Repeat for Shell (execute commands)
+
+- Restart MindRoot:
+
+- Go to Admin | Server Settings |  Server Control
+- Click on Restart Server
+
+.. image:: restart.png

mindroot/docs/installation.rst

@@ -0,0 +1,21 @@
+Installation
+============
+
+If MindRoot is already installed and running, skip to :doc:`LLM Plugin Installation <llm_plugin_installation>`.
+If using pre-configured MindRoot hosting, skip to :doc:`LLM API Key <llm_api_key>`.
+
+Create and enter a directory for your mindroot instance:
+
+``mkdir ~/mymindroot && cd ~/mymindroot``
+
+Usually you need to create a python virtual environment:
+
+``python -m venv .venv``
+
+And activate:
+
+``source .venv/bin/activate``
+
+Then just install with pip:
+
+``pip install mindroot``

mindroot/docs/llm_api_key.rst

@@ -0,0 +1,22 @@
+LLM API Key
+===========
+
+For this section you will need an API key from an LLM provider.
+We will assume OpenRouter for this example.
+
+Now, enter your `OpenRouter API key <https://openrouter.ai/settings/keys>`_:
+
+- Go to `/admin` (Admin link on home page) Advanced | Environment Variables
+
+.. image:: envvar.png
+
+- Find the ah_openrouter section and the `OPENROUTER_KEY` field; click Edit.
+
+- Enter your key and press Save.
+
+Finally, restart MindRoot:
+
+- Go to Admin | Server Settings |  Server Control 
+- Click on Restart Server
+
+.. image:: restart.png

mindroot/docs/llm_plugin_installation.rst

@@ -0,0 +1,27 @@
+LLM Plugin Installation
+=======================
+
+- Go to the `/admin` page by clicking the Admin link at the top of the home page.
+
+- Go to the Install/Registry tab
+
+- Search for 'OpenRouter' and click Install next to the result that comes up.
+
+.. image:: installopenrouter.png
+
+- A dialog will show the log of the installation.
+
+- Restart: Server Settings | Server Control | Restart
+
+.. image:: restart.png
+
+
+If you want, you can make sure the OpenRouter Plugin is installed:
+
+- Go to the /admin page (Admin link on home page)
+
+- Expand the Advanced section and click on Plugins
+
+- OpenRouter/ah_openrouter should show up
+
+.. image:: openrouter.png

mindroot/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

mindroot/docs/personas/local/Assistant/persona.json

@@ -0,0 +1,7 @@
+{
+  "name": "Assistant",
+  "description": "You are an advanced AI.",
+  "speech_patterns": "Brief and informal unless the user converses in a different manner, which you should adjust to.",
+  "faceref": "/xfiles/xintest3/test4/lib/python3.11/site-packages/xingen/coreplugins/static/personas/Assistant/faceref.png",
+  "avatar": "/xfiles/xintest3/test4/lib/python3.11/site-packages/xingen/coreplugins/static/personas/Assistant/avatar.png"
+}

mindroot/docs/programming_task.rst

@@ -0,0 +1,10 @@
+Give Assistant a Programming Task
+=================================
+
+- On the home page, click the Assistant button to open a new chat.
+
+- "Create a simple but beautiful web page about the phases of the moon. Save to ./imgs/moon.html and provide a clickable link to /imgs/moon.html"
+
+.. image:: moon.png
+
+(Note: shown is typical output from DeepSeek Chat 3.1)

mindroot/docs/source/ahp.rst

@@ -0,0 +1,7 @@
+ahp module
+==========
+
+.. automodule:: ahp
+   :members:
+   :show-inheritance:
+   :undoc-members:

mindroot/docs/source/mindroot.coreplugins.admin.rst

@@ -0,0 +1,189 @@
+mindroot.coreplugins.admin package
+==================================
+
+Submodules
+----------
+
+mindroot.coreplugins.admin.agent\_importer module
+-------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.agent_importer
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.agent\_router module
+-----------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.agent_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.asset\_manager module
+------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.asset_manager
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.command\_router module
+-------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.command_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.mcp\_catalog\_routes module
+------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.mcp_catalog_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.mcp\_publish\_routes module
+------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.mcp_publish_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.mcp\_registry\_routes module
+-------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.mcp_registry_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.mcp\_routes module
+---------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.mcp_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.mod module
+-------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.mod
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.oauth\_callback\_router module
+---------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.oauth_callback_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.persona\_handler module
+--------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.persona_handler
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.persona\_router module
+-------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.persona_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.plugin\_manager module
+-------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.plugin_manager
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.plugin\_router module
+------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.plugin_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.plugin\_router\_fixed module
+-------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.plugin_router_fixed
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.plugin\_router\_new\_not\_working module
+-------------------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.plugin_router_new_not_working
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.plugin\_routes module
+------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.plugin_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.registry\_settings\_routes module
+------------------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.registry_settings_routes
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.router module
+----------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.server\_router module
+------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.server_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.service\_models module
+-------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.service_models
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+mindroot.coreplugins.admin.settings\_router module
+--------------------------------------------------
+
+.. automodule:: mindroot.coreplugins.admin.settings_router
+   :members:
+   :show-inheritance:
+   :undoc-members:
+
+Module contents
+---------------
+
+.. automodule:: mindroot.coreplugins.admin
+   :members:
+   :show-inheritance:
+   :undoc-members: