Merge branch 'main' into devin/1734735936-add-weaviate-tool

Author: bboynton97

.github/workflows/codecov.yml

@@ -0,0 +1,43 @@
+name: Codecov
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - 'agentstack/**/*.py'
+  pull_request:
+    branches:
+      - main
+    paths:
+      - 'agentstack/**/*.py'
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+
+    steps:
+    - name: Checkout code
+      uses: actions/checkout@v2
+
+    - name: Set up Python
+      uses: actions/setup-python@v2
+      with:
+        python-version: 3.11
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install tox
+
+    - name: Run tests with tox
+      run: tox
+
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v5
+      with:
+        token: ${{ secrets.CODECOV_TOKEN }}
+        files: ./coverage.xml
+        flags: unittests
+        name: codecov-umbrella
+        fail_ci_if_error: true

.github/workflows/deploy.yml

@@ -18,11 +18,43 @@ jobs:
           python-version: '3.9'
 
       - name: Install dependencies
-        run: pip install build twine
+        run: pip install build twine toml
 
       - name: Build the package
         run: python -m build
 
+      - name: Check version matches
+        run: |
+          import toml
+          import os
+          import sys
+
+          # Read pyproject.toml
+          with open('pyproject.toml', 'r') as f:
+              pyproject = toml.load(f)
+
+          # Get version from pyproject.toml
+          project_version = pyproject['project']['version']
+
+          # Get release tag (strip 'v' prefix if present)
+          github_ref = os.environ['GITHUB_REF']
+          tag_version = github_ref.split('/')[-1]
+          if tag_version.startswith('v'):
+              tag_version = tag_version[1:]
+
+          print(f"pyproject.toml version: {project_version}")
+          print(f"Release tag version: {tag_version}")
+
+          # Compare versions
+          if project_version != tag_version:
+              print("Version mismatch!")
+              print(f"pyproject.toml version ({project_version}) does not match")
+              print(f"release tag version ({tag_version})")
+              sys.exit(1)
+
+          print("Versions match!")
+        shell: python
+
       - name: Upload to PyPI
         env:
           TWINE_USERNAME: ${{ secrets.PYPI_USERNAME }}

.github/workflows/mintlify-check.yml

@@ -0,0 +1,38 @@
+name: Mintlify Documentation Check
+on:
+  pull_request:
+    paths:
+      - 'docs/**'  # Only trigger on changes to docs directory
+      - 'mint.json'  # Also trigger on mintlify config changes
+
+jobs:
+  build-docs:
+    name: Build Documentation
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v4
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: '18'
+
+      - name: Install Mintlify
+        run: npm install -g mintlify
+
+      - name: Test documentation
+        run: |
+          cd docs
+          # If mintlify dev has errors, it will exit with status 1
+          # If it starts successfully, kill it after 5 seconds
+          timeout 5s mintlify dev || exit_status=$?
+          if [ $exit_status -eq 124 ]; then
+            # timeout exit code 124 means the process was killed after starting successfully
+            echo "Documentation built successfully!"
+            exit 0
+          else
+            echo "Documentation failed to build! Try running `mintlify dev` from the docs dir locally"
+            exit 1
+          fi

.gitignore

@@ -162,7 +162,14 @@ cython_debug/
 #  option (not recommended) you can uncomment the following to ignore the entire idea folder.
 .idea/
 
+# aider
+.aider*
+
+# VSCode
+.vscode
+
 # AgentStack
+.agentstack*
 example_project/
 ex/
 **/ex/
@@ -171,5 +178,6 @@ cookiecutter.json
 examples/tests/
 examples/tests/**/*
 
+uv.lock
 .DS_Store
 

CONTRIBUTING.md

@@ -3,6 +3,11 @@ First of all, __thank you__ for your interest in contributing to AgentStack! Eve
 
 Our vision is to build the defacto CLI for quickly spinning up an AI Agent project. We want to be the [create-react-app](https://create-react-app.dev/) of agents. Our inspiration also includes the oh-so-convenient [Angular CLI](https://v17.angular.io/cli).
 
+### Exclusive Contributor Sticker
+AgentStack contributors all receive a free sticker pack including an exclusive holographic sticker only available to contributors to the project :)
+
+Once your PR is merge, fill out [this form](https://docs.google.com/forms/d/e/1FAIpQLSfvBEnsT8nsQleonJHoWQtHuhbsgUJ0a9IjOqeZbMGkga2NtA/viewform?usp=sf_link) and I'll send your sticker pack out ASAP! <3
+
 ## How to Help
 
 Grab an issue from the [issues tab](https://github.com/AgentOps-AI/AgentStack/issues)! Plenty are labelled "Good First Issue". Fork the repo and create a PR when ready!
@@ -12,28 +17,17 @@ The best place to engage in conversation about your contribution is in the Issue
 ## Setup
 
 1. Clone the repo
-2. `poetry install`
-3. `pip install -e .[dev,test]`
-   - This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes
+   `git clone https://github.com/AgentOps-AI/AgentStack.git`
+   `cd AgentStack`
+2. Install agentstack as an edtiable project and set it up for development and testing
+   `pip install -e .[dev,test]`
+   This will install the CLI locally and in editable mode so you can use `agentstack <command>` to test your latest changes
 
-## Project Structure
-TODO
 
 ## Adding Tools
 If you're reading this section, you probably have a product that AI agents can use as a tool. We're glad you're here!
 
-Adding tools is easy once you understand the project structure. A few things need to be done for a tool to be considered completely supported:
-
-1. Modify `agentstack/tools/tools.json`
-   - Add your tool and relevant information to this file as appropriate.
-2. Create a config for your tool
-   - As an example, look at `mem0.json`
-   - AgentStack uses this to know what code to insert where. Follow the structure to add your tool.
-3. Create your implementation for each framework
-   - In `agentstack/templates/<framework>/tools`, you'll see other implementations of tools.
-   - Build your tool implementation for that framework. This file will be inserted in the user's project.
-   - The tools that are exported from this file should be listed in the tool's config json.
-4. Manually test your tool integration by running `agentstack tools add <your_tool>` and ensure it behaves as expected.
+Adding tools is easy once you understand the project structure. Our documentation for adding tools is available on our hosted docs [here](https://docs.agentstack.sh/contributing/adding-tools).
 
 ## Before creating your PR
 Be sure that you are opening a PR using a branch other than `main` on your fork. This enables us
@@ -59,4 +53,33 @@ pre-commit install
 ```
 
 ## Tests
-HAHAHAHAHAHAHA good one
+CLI tests are a bit hacky, so we are not tracking coverage. 
+That said, _some_ testing is required for any new functionality added by a PR.
+
+Tests MUST pass to have your PR merged. We _will not_ allow main to be in a failing state, so if your tests are failing, this is your problem to fix.
+
+### Run tests locally
+Install the testing requirements
+```bash
+pip install 'agentstack[test]'
+```
+
+Then run tests in all supported python versions with
+```bash
+tox
+```
+
+## Need Help?
+If you're reading this, we're very thankful you wanted to contribute! I understand it can be a little overwhelming to 
+get up to speed on a project like this and we are here to help!
+
+### Open a draft PR
+While we can't promise to write code for you, if you're stuck or need advice/help, open a draft PR and explain what you were trying to build and where you're stuck! Chances are, one of us have the context needed to help you get unstuck :)
+
+### Chat on our Discord
+We have an active [Discord server](https://discord.gg/JdWkh9tgTQ) with contributors and AgentStack users! There is a channel just for contributors on there. Feel free to drop a message explaining what you're trying to build and why you're stuck. Someone from our team should reply soon!
+
+# Thank You!
+The team behind AgentStack believe that the barrier to entry for building agents is far too high right now! We believe that this technology can be streamlined and made more accessible. If you're here, you likely feel the same! Any contribution is appreciated.
+
+If you're looking for work, we are _always_ open to hiring passionate engineers of all skill levels! While closing issues cannot guarantee an offer, we've found that engineers who contribute to our open source repo are some of the best we could ever hope to find via recruiters! Be active in the community and let us know you're interested in joining the team!

MANIFEST.in

@@ -1,3 +1,3 @@
 recursive-include agentstack/templates *
-recursive-include agentstack/tools *
+recursive-include agentstack/_tools *
 include agentstack.json .env .env.example

README.md

@@ -1,4 +1,4 @@
-# AgentStack [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+# AgentStack [![Python 3.10+](https://img.shields.io/badge/python-3.10+-blue.svg)](https://www.python.org/downloads/release/python-3100/) [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT) ![python-testing](https://github.com/agentops-ai/agentstack/actions/workflows/python-testing.yml/badge.svg) ![mypy](https://github.com/agentops-ai/agentstack/actions/workflows/mypy.yml/badge.svg) [![codecov.io](https://codecov.io/github/agentops-ai/agentstack/coverage.svg?branch=master)](https://codecov.io/github/agentops-ai/agentstack>?branch=master)
 
 <img alt="Logo" align="right" src="https://raw.githubusercontent.com/bboynton97/agentstack-docs/3491fe490ea535e7def74c83182dfa8dcfb1f562/logo/dark-sm.svg" width="20%" />
 
@@ -24,9 +24,10 @@ pip install agentstack
 agentstack init <project_name>
 ```
 
+AgentStack scaffolds your _agent stack_ - the tech stack that collectively is your agent
 
 <p align='center'>
-<img src='https://raw.githubusercontent.com/agentops-ai/agentstack/main/stack.png' width='600' alt='agentstack init'>
+<img src='https://github.com/AgentOps-AI/AgentStack/blob/7b40e53bf7300f69e3291c62d5b45e46ff818245/docs/images/the_agent_stack.png?raw=true' width='600' alt='agentstack init'>
 </p>
 
 ### Get Started Immediately

agentstack/__init__.py

@@ -1,9 +1,10 @@
 """
-This it the beginning of the agentstack public API. 
+This it the beginning of the agentstack public API.
 
 Methods that have been imported into this file are expected to be used by the
-end user inside of their project. 
+end user inside of their project.
 """
+
 from typing import Callable
 from pathlib import Path
 from agentstack import conf
@@ -12,11 +13,11 @@
 from agentstack import frameworks
 
 ___all___ = [
-    "conf", 
-    "tools", 
-    "get_tags", 
-    "get_framework", 
-    "get_inputs", 
+    "conf",
+    "tools",
+    "get_tags",
+    "get_framework",
+    "get_inputs",
 ]
 
 
@@ -29,14 +30,15 @@ def get_tags() -> list[str]:
 
 class ToolLoader:
     """
-    Provides the public interface for accessing tools, wrapped in the 
-    framework-specific callable format. 
-    
+    Provides the public interface for accessing tools, wrapped in the
+    framework-specific callable format.
+
     Get a tool's callables by name with `agentstack.tools[tool_name]`
     Include them in your agent's tool list with `tools = [*agentstack.tools[tool_name], ]`
     """
+
     def __getitem__(self, tool_name: str) -> list[Callable]:
         return frameworks.get_tool_callables(tool_name)
 
-tools = ToolLoader()
 
+tools = ToolLoader()