init 0.1.0

Author: thewebscraping

.env.example

@@ -0,0 +1,35 @@
+# OpenAI (for embeddings)
+OPENAI_API_KEY=sk-your-key-here
+OPENAI_EMBEDDING_MODEL=text-embedding-3-small
+
+# AstraDB
+ASTRA_DB_APPLICATION_TOKEN=AstraCS:your-token-here
+ASTRA_DB_API_ENDPOINT=https://your-id.apps.astra.datastax.com
+ASTRA_DB_COLLECTION_NAME=vector_documents
+
+# ChromaDB Cloud (optional)
+CHROMA_API_KEY=your-chroma-api-key
+CHROMA_CLOUD_TENANT=your-tenant
+CHROMA_CLOUD_DATABASE=your-database
+
+# ChromaDB HTTP Server (optional)
+CHROMA_HTTP_HOST=localhost
+CHROMA_HTTP_PORT=8000
+
+# ChromaDB Local (optional)
+CHROMA_PERSIST_DIR=./chroma_data
+
+# Milvus
+MILVUS_API_ENDPOINT=https://your-endpoint.zillizcloud.com
+MILVUS_USER=your-user
+MILVUS_PASSWORD=your-password
+
+# PGVector (PostgreSQL with pgvector extension)
+PGVECTOR_HOST=localhost
+PGVECTOR_PORT=5432
+PGVECTOR_DBNAME=vectordb
+PGVECTOR_USER=postgres
+PGVECTOR_PASSWORD=your-password
+
+# Vector metric (cosine, dot_product, euclidean)
+VECTOR_METRIC=cosine

.github/workflows/ci.yml

@@ -0,0 +1,54 @@
+name: CI
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ["3.11", "3.12"]
+
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v5
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e ".[all,dev]"
+
+    - name: Run tests
+      run: |
+        pytest
+
+    - name: Run pre-commit
+      run: uv run pre-commit run --all-files
+
+  docs:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v4
+
+    - name: Set up Python 3.11
+      uses: actions/setup-python@v5
+      with:
+        python-version: "3.11"
+
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install mkdocs-material mkdocstrings[python]
+        pip install -e ".[all]"
+
+    - name: Build docs
+      run: |
+        mkdocs build

.github/workflows/docs.yml

@@ -0,0 +1,39 @@
+name: Deploy Docs
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - "docs/**"
+      - "mkdocs.yml"
+      - ".github/workflows/docs.yml"
+
+permissions:
+  contents: write
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Configure Git Credentials
+        run: |
+          git config user.name github-actions[bot]
+          git config user.email 41898282+github-actions[bot]@users.noreply.github.com
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install mkdocs-material mkdocstrings[python]
+          pip install -e ".[all]"
+
+      - name: Deploy docs
+        run: |
+          mkdocs gh-deploy --force

.github/workflows/publish.yml

@@ -0,0 +1,32 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  build-and-publish:
+    runs-on: ubuntu-latest
+    permissions:
+      id-token: write  # IMPORTANT: this permission is mandatory for trusted publishing
+      contents: read
+
+    steps:
+    - 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
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Publish to PyPI
+      uses: pypa/gh-action-pypi-publish@release/v1

.github/workflows/test-build.yml

@@ -0,0 +1,41 @@
+name: Test Package Build
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test-build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - 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
+
+    - name: Build package
+      run: |
+        python -m build
+
+    - name: Check package with twine
+      run: |
+        twine check dist/*
+
+    - name: List built packages
+      run: |
+        ls -lh dist/
+
+    - name: Test install from wheel
+      run: |
+        pip install dist/*.whl
+        python -c "import crossvector; print(f'CrossVector version: {crossvector.__version__ if hasattr(crossvector, \"__version__\") else \"N/A\"}')"