microbots 0.0.2__tar.gz → 0.0.4__tar.gz

microbots-0.0.4/.github/workflows/dockerBuildPush.yml

@@ -0,0 +1,35 @@
+name: Build and Push to Docker Hub
+
+on:
+  push:
+    paths:
+      - 'src/microbots/environment/local_docker/image_builder/Dockerfile'
+      - 'src/microbots/environment/local_docker/image_builder/dockerShell.py'
+      - 'src/microbots/environment/local_docker/image_builder/ShellCommunicator.py'
+      - '.github/workflows/dockerBuildPush.yml'
+    branches:
+      - main
+
+jobs:
+  build-and-push:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to Docker Hub
+        uses: docker/login-action@v3
+        with:
+          username: ${{ secrets.DOCKERHUB_USERNAME }}
+          password: ${{ secrets.DOCKERHUB_TOKEN }}
+
+      - name: Build and push Docker image
+        run: |
+          IMAGE_NAME=${{ secrets.DOCKERHUB_USERNAME }}/shell_server
+          TAG=${{ github.sha }}
+
+          # build with both commit SHA and latest tag
+          docker build -f src/microbots/environment/local_docker/image_builder/Dockerfile -t $IMAGE_NAME:$TAG -t $IMAGE_NAME:latest .
+          docker push $IMAGE_NAME:$TAG
+          docker push $IMAGE_NAME:latest

microbots-0.0.4/.github/workflows/publish.yml

@@ -0,0 +1,61 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+
+  build-and-publish:
+    needs: test
+    runs-on: ubuntu-latest
+    # Only publish on push to main
+    if: github.event_name == 'release'
+    
+    permissions:
+      id-token: write
+      contents: read
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+          pip install -e .
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: python -m twine check dist/*
+
+      # Publish directly to PyPI
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          user: ${{ secrets.PYPI_USERNAME }}
+          password: ${{ secrets.PYPI_API_TOKEN }}
+          verbose: true

microbots-0.0.4/.gitignore

@@ -0,0 +1,206 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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:
+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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#uv.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+#poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+#pdm.lock
+#pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+#pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+#.idea/
+
+# Abstra
+# Abstra is an AI-powered process automation framework.
+# Ignore directories containing user credentials, local state, and settings.
+# Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#  Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#  that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#  and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#  you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Cursor
+#  Cursor is an AI-powered code editor. `.cursorignore` specifies files/directories to
+#  exclude from AI features like autocomplete and code analysis. Recommended for sensitive data
+#  refer to https://docs.cursor.com/context/ignore-files
+.cursorignore
+.cursorindexingignore
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/

microbots-0.0.4/PKG-INFO

@@ -0,0 +1,144 @@
+Metadata-Version: 2.4
+Name: microbots
+Version: 0.0.4
+Summary: container-based autonomous agent framework
+Author-email: xxx <xxx@example.com>
+License: MIT License
+        
+        Copyright (c) 2025 Bala
+        
+        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.
+        
+Project-URL: Source Repo, https://github.com/microsoft/minions
+Project-URL: Issues, https://github.com/microsoft/minions/issues
+Keywords: agent,bot,micro
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3.11
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: openai==1.107.3
+Requires-Dist: python-dotenv==1.1.1
+Requires-Dist: docker==7.1.0
+Requires-Dist: fastapi==0.116.1
+Requires-Dist: uvicorn==0.35.0
+Requires-Dist: pydantic==2.11.9
+Requires-Dist: swe-rex==1.4.0
+Requires-Dist: aiohttp==3.12.15
+Requires-Dist: pyyaml==6.0.2
+Dynamic: license-file
+
+# 🤖 Microbots
+
+MicroBots is a lightweight, extensible AI agent for code comprehension and controlled file edits. It integrates cleanly 
+into automation pipelines, mounting a target directory with explicit read-only or read/write modes so LLMs can safely 
+inspect, refactor, or generate files with least‑privilege access.
+
+
+```py
+from microbots import WritingBot
+
+myWritingBot = WritingBot(
+    model="azure-openai/my-gpt5", # model format : <provider/deployment_model_name>
+    folder_to_mount=str("myReactApp"),
+)
+
+data = myWritingBot.run("""when doing npm run build, I get an error. 
+Fix the error and make sure the build is successful.""", timeout_in_seconds=600)
+print(data.results)
+```
+
+## ⚠️ Project Status: Highly Unstable
+This project is currently **under active development** and is considered **highly unstable**. Features, APIs, and internal structures are subject to change without notice, and unexpected behavior may occur.
+Please **use with caution** in production environments.
+
+## 🚀 How to install
+
+### Pre-requisites
+
+- Docker
+- AI LLM Provider and API Key
+
+### Install Microbots
+
+```bash
+pip install microbots
+```
+
+
+## ✨LLM Support
+    
+Azure OpenAI Models - Add the below environment variables in a `.env` file in the root of your application
+
+```env
+OPEN_AI_END_POINT=XXXXXXXXXXXXXXXXXXXXXXXXXX
+OPEN_AI_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+## 🤖 Bots & Usage Examples
+
+Pre-requisite for the below example code of Bots:   
+From the root of your application, Create a folder called  `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code
+
+
+### 📖 ReadingBot
+
+
+```py
+from microbots import ReadingBot
+
+myBot = ReadingBot(
+    model="azure-openai/my-gpt5",
+    folder_to_mount="code"
+)
+
+runResult = myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Find the error and explain me what is the error", timeout_in_seconds=600)
+print(runResult)
+
+```
+
+The `ReadingBot` will read the files inside `code` folder and will extract information based on specific instructions given to the bot.
+
+
+### ✍️ WritingBot
+
+Pre-requisite for the example code: 
+From the root the application, Create a folder called  `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code
+
+```py
+from microbots import WritingBot
+
+myBot = WritingBot(
+    model="azure-openai/my-gpt5",
+    folder_to_mount="code"
+)
+
+myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Fix the error and make sure the code runs without any errors.", timeout_in_seconds=600)
+```
+
+The `WritingBot` will read and write the files inside `code` folder based on specific instructions given to the bot.
+
+## ⚙️ How it works
+
+
+![Overall Architecture Image](./docs/images/overall_architecture.png)
+
+The MicroBots create a containerized environment and mount the specified directory with restricting the permissions to read-only or read/write based on Bot used. It ensures that the AI agents operate within defined boundaries which enhances security and control over code modifications as well as protecting the local environment.

microbots-0.0.4/README.md

@@ -0,0 +1,96 @@
+# 🤖 Microbots
+
+MicroBots is a lightweight, extensible AI agent for code comprehension and controlled file edits. It integrates cleanly 
+into automation pipelines, mounting a target directory with explicit read-only or read/write modes so LLMs can safely 
+inspect, refactor, or generate files with least‑privilege access.
+
+
+```py
+from microbots import WritingBot
+
+myWritingBot = WritingBot(
+    model="azure-openai/my-gpt5", # model format : <provider/deployment_model_name>
+    folder_to_mount=str("myReactApp"),
+)
+
+data = myWritingBot.run("""when doing npm run build, I get an error. 
+Fix the error and make sure the build is successful.""", timeout_in_seconds=600)
+print(data.results)
+```
+
+## ⚠️ Project Status: Highly Unstable
+This project is currently **under active development** and is considered **highly unstable**. Features, APIs, and internal structures are subject to change without notice, and unexpected behavior may occur.
+Please **use with caution** in production environments.
+
+## 🚀 How to install
+
+### Pre-requisites
+
+- Docker
+- AI LLM Provider and API Key
+
+### Install Microbots
+
+```bash
+pip install microbots
+```
+
+
+## ✨LLM Support
+    
+Azure OpenAI Models - Add the below environment variables in a `.env` file in the root of your application
+
+```env
+OPEN_AI_END_POINT=XXXXXXXXXXXXXXXXXXXXXXXXXX
+OPEN_AI_KEY=XXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX
+```
+
+## 🤖 Bots & Usage Examples
+
+Pre-requisite for the below example code of Bots:   
+From the root of your application, Create a folder called  `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code
+
+
+### 📖 ReadingBot
+
+
+```py
+from microbots import ReadingBot
+
+myBot = ReadingBot(
+    model="azure-openai/my-gpt5",
+    folder_to_mount="code"
+)
+
+runResult = myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Find the error and explain me what is the error", timeout_in_seconds=600)
+print(runResult)
+
+```
+
+The `ReadingBot` will read the files inside `code` folder and will extract information based on specific instructions given to the bot.
+
+
+### ✍️ WritingBot
+
+Pre-requisite for the example code: 
+From the root the application, Create a folder called  `code` inside which clone the repo `https://github.com/swe-agent/test-repo/`. Now run the code
+
+```py
+from microbots import WritingBot
+
+myBot = WritingBot(
+    model="azure-openai/my-gpt5",
+    folder_to_mount="code"
+)
+
+myBot.run("When I am running missing_colon.py I am getting SyntaxError: invalid syntax. Fix the error and make sure the code runs without any errors.", timeout_in_seconds=600)
+```
+
+The `WritingBot` will read and write the files inside `code` folder based on specific instructions given to the bot.
+
+## ⚙️ How it works
+
+
+![Overall Architecture Image](./docs/images/overall_architecture.png)
+
+The MicroBots create a containerized environment and mount the specified directory with restricting the permissions to read-only or read/write based on Bot used. It ensures that the AI agents operate within defined boundaries which enhances security and control over code modifications as well as protecting the local environment.

microbots-0.0.4/architechture.md

@@ -0,0 +1,64 @@
+# Bot
+    Bot will accept "name", "permission" and "system_prompt", "llm", "environment", "additional_tools", "folder_to_mount
+        "Bot_type" => "READING_Bot" | "WRITING_Bot" | "BROWSING_Bot" | "CUSTOM_Bot"
+        "permission" => "READ_ONLY" | "READ_WRITE" (optional field)
+        "model_name" => { // Based on provider the Bot will instantiate llm instance
+            provider: "openai" 
+            model: "gpt-4" | "gpt-3.5-turbo" | "claude",
+        }
+        <!-- LLM should not give any interactive commands like vim -->
+        "system_prompt" => string (Optional argument)
+            when not passed will create default system prompt based on Bot_type and permission
+        "environment" => environment instance (Optional argument)
+            when not passed will create docker environment with default arguments as per PERMISSION based on Bot_type
+            and tools will be installed one by one after environment creation
+        "additional_tools" => array of tool definitions (Optional argument)
+            when passed will create docker environment with default arguments as per PERMISSION and with default "tool" installations with additional tools installed
+
+    Bot will expose "run" method which will accept a "task", "timeout" and "max_iterations"
+        will call llm task as user_prompt and get response
+        get the response and call environment execute method with the command
+        get the output and call llm with previous_communications and get the response
+        repeat the above steps until llm response is final answer or max_iterations reached or timeout reached
+        ensure to log every communication between llm and environment
+
+        <!-- In the end llm should provide status "DONE" status in one object property with results in another property -->
+
+        will return { status: bool, result: string, error: string | None, log: log of communication between llm and environment }
+        
+
+
+# environment
+    environment will accept "folder_to_mount", "permission"
+        "folder_to_mount" => string (path to the folder to mount inside docker)
+        "permission" => "READ_ONLY" | "READ_WRITE"
+
+    environment will expose "execute" method which will accept command, timeout and return {
+        return_code: int,
+        output: string,
+        error: string | None
+    }
+        will execute the command inside the docker with a default timeout and return the output
+    environment will expose "kill" method which will kill the environment
+        will stop the docker container and remove it
+
+# llm class
+
+    llm will accept "system_prompt" and "deployment_name"
+    system_prompt => string, 
+    deployment_name => string (like my-custom-gpt5-Bot)
+
+    llm will expose ask method which will accept "message" and will return llm response in particular json format
+        the method will append each message to messages array and each response also will be appended to the messages array, 
+    llm will expose clear history method which will clear the messages array except the system prompt
+    
+
+# tool definition singleton class
+    tool definition will accept "installation_command", "verification_command", "usage_instructions"
+
+Whenever I am writing code 
+```py
+import logging
+logger = logging.getLogger(__name__)
+logger.info("This is an info message")
+```

{microbots-0.0.2 → microbots-0.0.4}/pyproject.toml

@@ -1,9 +1,9 @@
 [build-system]
-requires = ["setuptools>=61.0", "wheel"]
+requires = ["setuptools>=61.0", "wheel", "setuptools-scm[toml]>=6.2"]
 build-backend = "setuptools.build_meta"
 
 [project]
-name = "microbots"  # package name on PyPI (unique)
+name = "microbots"
 dynamic = ["version", "dependencies"]
 description = "container-based autonomous agent framework"
 readme = "README.md"
@@ -23,7 +23,9 @@ requires-python = ">=3.11"
 
 [tool.setuptools.dynamic]
 dependencies = { file = ["requirements.txt"] }
-version = {attr ="microbots.__version__"}
+
+[tool.setuptools_scm]
+# This tells setuptools-scm to get version from git tags
 
 [tool.setuptools.packages.find]
 where = ["src"]

microbots-0.0.4/pytest.ini

@@ -0,0 +1,4 @@
+[pytest]
+markers =
+    docker: marks tests that require a running Docker daemon and pull container images
+