cognitrix 0.2.4__tar.gz → 0.2.6__tar.gz

cognitrix-0.2.6/PKG-INFO

@@ -0,0 +1,257 @@
+Metadata-Version: 2.4
+Name: cognitrix
+Version: 0.2.6
+Summary: Package for creating AI Agents using llms
+License: Apache2
+License-File: LICENSE
+Keywords: cognitrix,ai,agents,ai agents,ai-agents,llms,autonomous agents
+Author: theonlyamos
+Author-email: theonlyamos@gmail.com
+Requires-Python: >=3.11,<3.14
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: License :: Other/Proprietary License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Dist: aiofiles (>=23.2.1,<24.0.0)
+Requires-Dist: aiohttp (>=3.9.3,<4.0.0)
+Requires-Dist: bcrypt (>=4.3.0,<5.0.0)
+Requires-Dist: beautifulsoup4 (>=4.12.3,<5.0.0)
+Requires-Dist: celery[redis] (>=5.4.0,<6.0.0)
+Requires-Dist: chromadb (>=1.5.0,<2.0.0)
+Requires-Dist: fastapi (>=0.112.0,<0.113.0)
+Requires-Dist: httpx (>=0.28.1,<0.29.0)
+Requires-Dist: mcp[cli] (>=1.9.1,<2.0.0)
+Requires-Dist: numpy (>=2.0.0,<3.0.0)
+Requires-Dist: odbms (==0.5.2)
+Requires-Dist: openai (>=2.24.0,<3.0.0)
+Requires-Dist: pillow (>=10.2.0,<11.0.0)
+Requires-Dist: pyautogui (>=0.9.54,<0.10.0)
+Requires-Dist: pydantic (>=2.6.2,<3.0.0)
+Requires-Dist: pyjwt (>=2.8.0,<3.0.0)
+Requires-Dist: pymupdf (>=1.27.2,<2.0.0)
+Requires-Dist: python-dotenv (>=1.0.1,<2.0.0)
+Requires-Dist: python-multipart (>=0.0.9,<0.0.10)
+Requires-Dist: pyyaml (>=6.0,<7.0)
+Requires-Dist: requests (>=2.31.0,<3.0.0)
+Requires-Dist: rich (>=13.7.1)
+Requires-Dist: sentence-transformers (>=5.2.0,<6.0.0)
+Requires-Dist: sse-starlette (>=2.1.2,<3.0.0)
+Requires-Dist: tavily-python (>=0.3.3,<0.4.0)
+Requires-Dist: textual (>=8.0.1,<9.0.0)
+Requires-Dist: uvicorn (>=0.30.1,<0.31.0)
+Requires-Dist: wikipedia (>=1.4.0,<2.0.0)
+Requires-Dist: xmltodict (>=0.13.0,<0.14.0)
+Project-URL: Bug Tracker, https://github.com/theonlyamos/cognitrix/issues
+Project-URL: Homepage, https://github.com/theonlyamos/cognitrix
+Project-URL: Repository, https://github.com/theonlyamos/cognitrix
+Description-Content-Type: text/markdown
+
+# Cognitrix
+
+Cognitrix is an open-source autonomous AI agents orchestrator built in Python. It allows you to create and manage AI agents with ease and integrates seamlessly with large language models (LLMs) from various providers.
+
+## Features
+
+- **Agent Creation and Management:** Create, list, and load AI agents with customizable names, tasks, and configurations.
+- **LLM Integration:** Integrates with multiple LLM providers via OpenRouter (200+ models including OpenAI, Anthropic, Google, Meta, Mistral) plus local models via Ollama.
+- **Modular Architecture:** Easily extensible, allowing the addition of new tools, agents, and LLM integrations.
+- **Conversational Interface:** Interact with AI agents through a command-line interface, providing queries and receiving responses.
+- **Tool Integration:** Agents can utilize a variety of tools, including calculators, web searches, file system browsers, and more.
+- **Autonomous Agent Mode:** Agents can operate autonomously, visually perceiving the screen, interacting with UI elements, and performing tasks.
+- **Multimodal Support:** Handles both text and image inputs/outputs, enabling multimodal interactions.
+
+## Architecture
+
+Cognitrix's architecture is designed to be highly modular and extensible:
+
+- **Agents:** The base `Agent` class is for creating and managing AI agents.
+- **LLMs:** Provider classes for OpenRouter (primary - 200+ models), OpenAI (direct), and Ollama (local).
+- **Tools:** A set of tools that agents can utilize. Each tool has a `category` attribute for grouping and management.
+- **Templates:** Customizable prompt templates guide the behavior and output formats of LLMs.
+
+More tools can be added by creating new classes that inherit from the `Tool` base class and specifying a unique `category`.
+
+## Installation
+
+**Prerequisites**
+
+- **Python 3.11–3.13** (the package will not build on 3.10 or lower).
+- **Node.js 18+** and a package manager (this repo uses **pnpm**) — only needed to build the web UI from source.
+- **Poetry** — only needed for building from source.
+- **Redis** — only needed if you use the background task API (Celery worker).
+
+**Install with pip**:
+
+```bash
+pip install cognitrix
+```
+
+**Build from source**:
+
+```bash
+git clone https://github.com/theonlyamos/cognitrix.git
+cd cognitrix/frontend
+pnpm install
+pnpm run build
+cd ..
+pip install .
+```
+
+**Install directly from github**:
+
+```bash
+pip install https://github.com/theonlyamos/cognitrix/archive/main.zip
+```
+
+**Build the Docker Image**:
+
+```bash
+git clone https://github.com/theonlyamos/cognitrix.git
+cd cognitrix
+docker build -t cognitrix .
+```
+
+## Usage
+
+**Fill these environment variables as needed**
+
+```bash
+OPENAI_API_KEY=
+CO_API_KEY=
+TAVILY_API_KEY=
+CLARIFAI_ACCESS_TOKEN=
+GROQ_API_KEY=
+GOOGLE_API_KEY=
+NEWSAPI_API_KEY=
+ANTHROPIC_API_KEY=
+DEEPGRAM_API_KEY=
+MINDSDB_API_KEY=
+BRAVE_SEARCH_API_KEY=
+AIMLAPI_API_KEY=
+```
+
+To run Cognitrix with default settings:
+
+```bash
+cognitrix
+```
+
+**Access the Web UI**
+
+To run with web interface
+
+```bash
+cognitrix --ui web
+```
+
+Open your web browser and go to `http://localhost:8000` to access the web UI.
+
+**Run the Docker Container**
+
+After building the image, you can run the container with:
+
+```bash
+docker run -p 8000:8000 cognitrix
+```
+
+This command maps port 8000 of the container to port 8000 on your host machine.
+
+To choose an LLM provider, pass `--provider` (config is read from the environment —
+`AI_PROVIDER`, `<PROVIDER>_BASE_URL`, `<PROVIDER>_API_KEY`, `<PROVIDER>_MODEL`):
+
+```bash
+cognitrix --provider openrouter
+```
+
+To list created agents:
+
+```bash
+cognitrix agents -l
+```
+
+To list available tools:
+
+```bash
+cognitrix tools -l
+```
+
+To run Cognitrix with a specific provider:
+
+```bash
+cognitrix --provider <provider_name>
+```
+
+To run Cognitrix with a specific agent:
+
+```bash
+cognitrix --agent <agent_name>
+```
+
+To run Cognitrix with a category of tools:
+
+```bash
+cognitrix --load-tools "web"
+```
+
+To run Cognitrix with categories of tools:
+
+```bash
+cognitrix --load-tools "web,general"
+```
+
+To create a new agent:
+
+```bash
+cognitrix agents --new
+```
+
+For more options and usage details, use the help command:
+
+```bash
+cognitrix --help
+```
+
+## Web UI
+
+Cognitrix includes a web UI built with React, TypeScript, and Vite. This UI allows users to interact with the AI agents and manage their configurations easily.
+
+### Development
+
+For development purposes, you can also run the web UI locally without Docker. Ensure you have Node.js 18+ and pnpm installed, then follow these steps:
+
+1. **Install Dependencies**:
+   Navigate to the `frontend` directory and run:
+
+   ```bash
+   pnpm install
+   ```
+
+2. **Start the Development Server**:
+   Run the following command to start the development server:
+
+   ```bash
+   pnpm run dev
+   ```
+
+3. **Access the Development Server**:
+   Open your web browser and go to `http://localhost:5173` to view the web UI in development mode.
+
+## Contributing
+
+Cognitrix is open source and contributions are welcome! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute.
+
+## License
+
+This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
+
+## Acknowledgments
+
+Cognitrix was created by [Amos Amissah](https://github.com/theonlyamos) and is inspired by projects like AutoGPT and GPTEngineer. Special thanks to the open-source community and AI companies providing LLM APIs.
+

cognitrix-0.2.6/README.md

@@ -0,0 +1,201 @@
+# Cognitrix
+
+Cognitrix is an open-source autonomous AI agents orchestrator built in Python. It allows you to create and manage AI agents with ease and integrates seamlessly with large language models (LLMs) from various providers.
+
+## Features
+
+- **Agent Creation and Management:** Create, list, and load AI agents with customizable names, tasks, and configurations.
+- **LLM Integration:** Integrates with multiple LLM providers via OpenRouter (200+ models including OpenAI, Anthropic, Google, Meta, Mistral) plus local models via Ollama.
+- **Modular Architecture:** Easily extensible, allowing the addition of new tools, agents, and LLM integrations.
+- **Conversational Interface:** Interact with AI agents through a command-line interface, providing queries and receiving responses.
+- **Tool Integration:** Agents can utilize a variety of tools, including calculators, web searches, file system browsers, and more.
+- **Autonomous Agent Mode:** Agents can operate autonomously, visually perceiving the screen, interacting with UI elements, and performing tasks.
+- **Multimodal Support:** Handles both text and image inputs/outputs, enabling multimodal interactions.
+
+## Architecture
+
+Cognitrix's architecture is designed to be highly modular and extensible:
+
+- **Agents:** The base `Agent` class is for creating and managing AI agents.
+- **LLMs:** Provider classes for OpenRouter (primary - 200+ models), OpenAI (direct), and Ollama (local).
+- **Tools:** A set of tools that agents can utilize. Each tool has a `category` attribute for grouping and management.
+- **Templates:** Customizable prompt templates guide the behavior and output formats of LLMs.
+
+More tools can be added by creating new classes that inherit from the `Tool` base class and specifying a unique `category`.
+
+## Installation
+
+**Prerequisites**
+
+- **Python 3.11–3.13** (the package will not build on 3.10 or lower).
+- **Node.js 18+** and a package manager (this repo uses **pnpm**) — only needed to build the web UI from source.
+- **Poetry** — only needed for building from source.
+- **Redis** — only needed if you use the background task API (Celery worker).
+
+**Install with pip**:
+
+```bash
+pip install cognitrix
+```
+
+**Build from source**:
+
+```bash
+git clone https://github.com/theonlyamos/cognitrix.git
+cd cognitrix/frontend
+pnpm install
+pnpm run build
+cd ..
+pip install .
+```
+
+**Install directly from github**:
+
+```bash
+pip install https://github.com/theonlyamos/cognitrix/archive/main.zip
+```
+
+**Build the Docker Image**:
+
+```bash
+git clone https://github.com/theonlyamos/cognitrix.git
+cd cognitrix
+docker build -t cognitrix .
+```
+
+## Usage
+
+**Fill these environment variables as needed**
+
+```bash
+OPENAI_API_KEY=
+CO_API_KEY=
+TAVILY_API_KEY=
+CLARIFAI_ACCESS_TOKEN=
+GROQ_API_KEY=
+GOOGLE_API_KEY=
+NEWSAPI_API_KEY=
+ANTHROPIC_API_KEY=
+DEEPGRAM_API_KEY=
+MINDSDB_API_KEY=
+BRAVE_SEARCH_API_KEY=
+AIMLAPI_API_KEY=
+```
+
+To run Cognitrix with default settings:
+
+```bash
+cognitrix
+```
+
+**Access the Web UI**
+
+To run with web interface
+
+```bash
+cognitrix --ui web
+```
+
+Open your web browser and go to `http://localhost:8000` to access the web UI.
+
+**Run the Docker Container**
+
+After building the image, you can run the container with:
+
+```bash
+docker run -p 8000:8000 cognitrix
+```
+
+This command maps port 8000 of the container to port 8000 on your host machine.
+
+To choose an LLM provider, pass `--provider` (config is read from the environment —
+`AI_PROVIDER`, `<PROVIDER>_BASE_URL`, `<PROVIDER>_API_KEY`, `<PROVIDER>_MODEL`):
+
+```bash
+cognitrix --provider openrouter
+```
+
+To list created agents:
+
+```bash
+cognitrix agents -l
+```
+
+To list available tools:
+
+```bash
+cognitrix tools -l
+```
+
+To run Cognitrix with a specific provider:
+
+```bash
+cognitrix --provider <provider_name>
+```
+
+To run Cognitrix with a specific agent:
+
+```bash
+cognitrix --agent <agent_name>
+```
+
+To run Cognitrix with a category of tools:
+
+```bash
+cognitrix --load-tools "web"
+```
+
+To run Cognitrix with categories of tools:
+
+```bash
+cognitrix --load-tools "web,general"
+```
+
+To create a new agent:
+
+```bash
+cognitrix agents --new
+```
+
+For more options and usage details, use the help command:
+
+```bash
+cognitrix --help
+```
+
+## Web UI
+
+Cognitrix includes a web UI built with React, TypeScript, and Vite. This UI allows users to interact with the AI agents and manage their configurations easily.
+
+### Development
+
+For development purposes, you can also run the web UI locally without Docker. Ensure you have Node.js 18+ and pnpm installed, then follow these steps:
+
+1. **Install Dependencies**:
+   Navigate to the `frontend` directory and run:
+
+   ```bash
+   pnpm install
+   ```
+
+2. **Start the Development Server**:
+   Run the following command to start the development server:
+
+   ```bash
+   pnpm run dev
+   ```
+
+3. **Access the Development Server**:
+   Open your web browser and go to `http://localhost:5173` to view the web UI in development mode.
+
+## Contributing
+
+Cognitrix is open source and contributions are welcome! Please refer to [CONTRIBUTING.md](CONTRIBUTING.md) for guidelines on how to contribute.
+
+## License
+
+This project is licensed under the Apache License 2.0. See [LICENSE](LICENSE) for more information.
+
+## Acknowledgments
+
+Cognitrix was created by [Amos Amissah](https://github.com/theonlyamos) and is inspired by projects like AutoGPT and GPTEngineer. Special thanks to the open-source community and AI companies providing LLM APIs.

cognitrix-0.2.6/cognitrix/__init__.py

@@ -0,0 +1,23 @@
+from .agents import Agent as Agent
+from .providers import LLM as LLM
+from .providers import LLMResponse as LLMResponse
+from .tools import Tool as Tool
+
+
+# Backward compatibility aliases
+def _llm_openai(): return LLM.load_llm("openai")
+def _llm_openrouter(): return LLM.load_llm("openrouter")
+def _llm_ollama(): return LLM.load_llm("ollama")
+OpenAI = _llm_openai
+OpenRouter = _llm_openrouter
+Ollama = _llm_ollama
+
+__all__ = [
+    "Tool",
+    "Agent",
+    "LLM",
+    "LLMResponse",
+    "OpenAI",
+    "OpenRouter",
+    "Ollama",
+]

cognitrix-0.2.6/cognitrix/agents/__init__.py

@@ -0,0 +1,15 @@
+from .base import Agent as Agent
+from .evaluator import Evaluator as Evaluator
+from .generators import (
+    PromptGenerator as PromptGenerator,
+)
+from .generators import (
+    TaskInstructor as TaskInstructor,
+)
+
+__all__ = [
+    "Agent",
+    "PromptGenerator",
+    "TaskInstructor",
+    "Evaluator",
+]