Merge pull request #50 from Annotation-Garden/develop

Release v0.6.1-alpha: CLI implementation and PyPI publishing

Author: neuromechanist

.env.example

@@ -18,6 +18,12 @@ API_KEYS=your-generated-api-key-here
 # Set to "false" only for local development without auth
 REQUIRE_API_AUTH=true
 
+# BYOK (Bring Your Own Key) Mode
+# When enabled, users can provide their own OpenRouter API key via X-OpenRouter-Key header
+# Their key is used for LLM calls (billing goes to their account)
+# Set to "false" to require server API keys only
+ALLOW_BYOK=true
+
 # Audit Logging (recommended for production)
 ENABLE_AUDIT_LOG=true
 AUDIT_LOG_FILE=/var/log/hedit/audit.log

.github/workflows/publish.yml

@@ -0,0 +1,86 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+    inputs:
+      test_pypi:
+        description: 'Publish to TestPyPI instead of PyPI'
+        required: false
+        default: false
+        type: boolean
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Build distribution
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: '3.12'
+
+      - name: Install build dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build twine
+
+      - name: Build package
+        run: python -m build
+
+      - name: Check package
+        run: twine check dist/*
+
+      - name: Upload artifacts
+        uses: actions/upload-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish-testpypi:
+    name: Publish to TestPyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'workflow_dispatch' && github.event.inputs.test_pypi == 'true'
+    environment:
+      name: testpypi
+      url: https://test.pypi.org/p/hedit
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/
+
+  publish-pypi:
+    name: Publish to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    if: github.event_name == 'release' || (github.event_name == 'workflow_dispatch' && github.event.inputs.test_pypi != 'true')
+    environment:
+      name: pypi
+      url: https://pypi.org/p/hedit
+    permissions:
+      id-token: write
+    steps:
+      - name: Download artifacts
+        uses: actions/download-artifact@v4
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/release.yml

@@ -54,27 +54,41 @@ jobs:
           tag_name: ${{ github.ref_name }}
           release_name: Release ${{ steps.get_version.outputs.VERSION }}
           body: |
-            ## HED-BOT ${{ steps.get_version.outputs.VERSION }}
+            ## HEDit ${{ steps.get_version.outputs.VERSION }}
 
             ${{ steps.changelog.outputs.CHANGELOG }}
 
             ---
 
             ### Installation
 
-            **Docker (Recommended):**
+            **PyPI (Recommended for CLI):**
+            ```bash
+            pip install hedit
+            ```
+
+            **Docker (for API server):**
             ```bash
             docker pull ghcr.io/${{ github.repository }}:${{ steps.get_version.outputs.VERSION }}
             ```
 
             **From Source:**
             ```bash
             git clone https://github.com/${{ github.repository }}.git
-            cd hed-bot
+            cd hedit
             git checkout v${{ steps.get_version.outputs.VERSION }}
             pip install -e .
             ```
 
+            ### Quick Start
+            ```bash
+            # Initialize with your OpenRouter API key
+            hedit init --api-key YOUR_KEY
+
+            # Generate HED annotation
+            hedit annotate "A red circle appears on screen"
+            ```
+
             ### Documentation
             See [README.md](https://github.com/${{ github.repository }}/blob/main/README.md) for setup and usage instructions.
           draft: false

.gitignore

@@ -36,6 +36,7 @@ ENV/
 # Claude specific
 CLAUDE.md
 .rules/
+.context/
 plan.md
 ideas.md
 scratch_notes.md

pyproject.toml

@@ -4,13 +4,23 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "hedit"
-version = "0.6.0-alpha"
+version = "0.6.1-alpha"
 description = "Multi-agent system for HED annotation generation and validation"
 readme = "README.md"
 requires-python = ">=3.12"
-license = {text = "MIT"}
+license = "MIT"
 authors = [
-    {name = "Yahya", email = "yahya@example.com"}
+    {name = "Annotation Garden Initiative", email = "info@annotation.garden"}
+]
+keywords = ["hed", "annotation", "neuroscience", "bids", "cli"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Environment :: Console",
+    "Intended Audience :: Science/Research",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
 ]
 
 dependencies = [
@@ -29,8 +39,22 @@ dependencies = [
     "lxml>=5.3.0",
     "beautifulsoup4>=4.12.3",
     "pillow>=11.0.0",
+    # CLI dependencies
+    "typer>=0.20.0",
+    "rich>=14.0.0",
+    "platformdirs>=4.5.0",
+    "pyyaml>=6.0.2",
 ]
 
+[project.scripts]
+hedit = "src.cli.main:cli"
+
+[project.urls]
+Homepage = "https://annotation.garden/hedit"
+Documentation = "https://github.com/Annotation-Garden/hedit#readme"
+Repository = "https://github.com/Annotation-Garden/hedit"
+Issues = "https://github.com/Annotation-Garden/hedit/issues"
+
 [project.optional-dependencies]
 dev = [
     "pytest>=8.3.0",
@@ -94,6 +118,10 @@ exclude_lines = [
     "raise NotImplementedError",
 ]
 
+[tool.setuptools.packages.find]
+where = ["."]
+include = ["src*"]
+
 [tool.mypy]
 python_version = "3.12"
 warn_return_any = true