cypherglot 0.0.0__tar.gz

cypherglot-0.0.0/.github/workflows/build-docs.yml

@@ -0,0 +1,50 @@
+name: Build Docs
+
+on:
+  push:
+    tags-ignore:
+      - 'v*'
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'README.md'
+      - '.github/workflows/build-docs.yml'
+  pull_request:
+    paths:
+      - 'docs/**'
+      - 'mkdocs.yml'
+      - 'README.md'
+      - '.github/workflows/build-docs.yml'
+  workflow_call:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  build-docs:
+    name: Build MkDocs site
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: '3.12'
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install docs dependencies
+        run: |
+          uv sync --group docs
+
+      - name: Build docs
+        env:
+          MIKE_VERSION: dev
+          MIKE_VERSION_TAG: main
+        run: |
+          uv run mkdocs build --strict

cypherglot-0.0.0/.github/workflows/deploy-docs.yml

@@ -0,0 +1,125 @@
+name: Deploy MkDocs to GitHub Pages
+
+on:
+  push:
+    tags:
+      - 'v*'
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Version to deploy (for example: 0.1.0 or v0.1.0)'
+        required: true
+      set_latest:
+        description: 'Set as latest version?'
+        required: true
+        type: boolean
+        default: true
+
+permissions:
+  contents: read
+
+concurrency:
+  group: pages
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    runs-on: ubuntu-latest
+    env:
+      DOCS_REPO: humemai/humemai-docs
+      DOCS_BRANCH: main
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+          token: ${{ secrets.GITHUB_TOKEN }}
+          persist-credentials: false
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: '3.12'
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install docs dependencies
+        run: |
+          uv sync --group docs
+
+      - name: Validate docs token
+        run: |
+          if [ -z "${{ secrets.HUMEMAI_DOCS_TOKEN }}" ]; then
+            echo "HUMEMAI_DOCS_TOKEN is missing"
+            exit 1
+          fi
+
+      - name: Extract version from tag or input
+        id: version
+        run: |
+          if [ "${{ github.event_name }}" = "workflow_dispatch" ]; then
+            RAW_VERSION="${{ github.event.inputs.version }}"
+            SET_LATEST="${{ github.event.inputs.set_latest }}"
+          else
+            RAW_VERSION="${{ github.ref_name }}"
+            SET_LATEST="true"
+          fi
+
+          VERSION="${RAW_VERSION#v}"
+          VERSION_TAG="v$VERSION"
+          echo "version=$VERSION" >> "$GITHUB_OUTPUT"
+          echo "version_tag=$VERSION_TAG" >> "$GITHUB_OUTPUT"
+          echo "set_latest=$SET_LATEST" >> "$GITHUB_OUTPUT"
+          echo "Deploying documentation version: $VERSION"
+          echo "Using source tag ref: $VERSION_TAG"
+
+      - name: Checkout humemai-docs
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          repository: ${{ env.DOCS_REPO }}
+          ref: ${{ env.DOCS_BRANCH }}
+          token: ${{ secrets.HUMEMAI_DOCS_TOKEN }}
+          path: humemai-docs
+
+      - name: Configure Git (humemai-docs)
+        run: |
+          git -C humemai-docs config user.name "github-actions[bot]"
+          git -C humemai-docs config user.email "github-actions[bot]@users.noreply.github.com"
+
+      - name: Deploy with mike (set as latest)
+        if: steps.version.outputs.set_latest == 'true'
+        working-directory: humemai-docs
+        env:
+          MIKE_VERSION: ${{ steps.version.outputs.version }}
+          MIKE_VERSION_TAG: ${{ steps.version.outputs.version_tag }}
+        run: |
+          uv run --project .. mike deploy --update-aliases \
+            --deploy-prefix cypherglot \
+            --branch ${{ env.DOCS_BRANCH }} \
+            --push \
+            --config-file ../mkdocs.yml \
+            ${{ steps.version.outputs.version }} latest \
+            --title "${{ steps.version.outputs.version }}"
+          uv run --project .. mike set-default \
+            --deploy-prefix cypherglot \
+            --branch ${{ env.DOCS_BRANCH }} \
+            --push \
+            --config-file ../mkdocs.yml \
+            latest
+
+      - name: Deploy with mike (not latest)
+        if: steps.version.outputs.set_latest != 'true'
+        working-directory: humemai-docs
+        env:
+          MIKE_VERSION: ${{ steps.version.outputs.version }}
+          MIKE_VERSION_TAG: ${{ steps.version.outputs.version_tag }}
+        run: |
+          uv run --project .. mike deploy \
+            --deploy-prefix cypherglot \
+            --branch ${{ env.DOCS_BRANCH }} \
+            --push \
+            --config-file ../mkdocs.yml \
+            ${{ steps.version.outputs.version }} \
+            --title "${{ steps.version.outputs.version }}"

cypherglot-0.0.0/.github/workflows/generated-cypher.yml

@@ -0,0 +1,24 @@
+name: Generated Cypher Artifacts
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  generated-cypher-check:
+    name: Generated Cypher Artifacts
+    runs-on: ubuntu-24.04
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Verify checked-in generated Cypher artifacts
+        run: |
+          bash scripts/dev/regenerate_cypher_frontend_docker.sh --check

cypherglot-0.0.0/.github/workflows/publish-pypi.yml

@@ -0,0 +1,75 @@
+name: Publish Python package to PyPI
+
+on:
+  push:
+    tags:
+      - "v*"
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  tests:
+    name: Run unit tests
+    uses: ./.github/workflows/test.yml
+
+  build:
+    name: Build package
+    runs-on: ubuntu-24.04
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: "3.12"
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install project and docs dependencies
+        run: |
+          uv sync --group docs
+
+      - name: Build docs
+        run: |
+          uv run mkdocs build --strict
+
+      - name: Build distributions
+        run: |
+          uv run --with build python -m build
+
+      - name: Check package metadata
+        run: |
+          uv run --with twine python -m twine check dist/*
+
+      - name: Verify wheel installation
+        run: |
+          uv run --isolated --with ./dist/*.whl python -c "import cypherglot; print(cypherglot.__version__)"
+
+      - name: Upload distributions
+        uses: actions/upload-artifact@65462800fd760344b1a7b4382951275a0abb4808 # v4.3.3
+        with:
+          name: python-package-distributions
+          path: dist/
+
+  publish:
+    name: Publish package to PyPI
+    needs: [tests, build]
+    if: startsWith(github.ref, 'refs/tags/v')
+    runs-on: ubuntu-24.04
+    permissions:
+      id-token: write
+    steps:
+      - name: Download distributions
+        uses: actions/download-artifact@634f93cb2916e3fdff6788551b99b062d0335ce0 # v5.0.0
+        with:
+          name: python-package-distributions
+          path: dist/
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@ed0c53931b1dc9bd32cbe73a98c7f6766f8a527e # release/v1

cypherglot-0.0.0/.github/workflows/test.yml

@@ -0,0 +1,59 @@
+name: Test
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+  workflow_call:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test (${{ matrix.platform }}, Python ${{ matrix.python-version }})
+    runs-on: ${{ matrix.runs-on }}
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version:
+          - '3.10'
+          - '3.11'
+          - '3.12'
+          - '3.13'
+          - '3.14'
+        platform:
+          - 'linux/amd64'
+          - 'linux/arm64'
+          - 'darwin/arm64'
+          - 'windows/amd64'
+        include:
+          - platform: 'linux/amd64'
+            runs-on: ubuntu-24.04
+          - platform: 'linux/arm64'
+            runs-on: ubuntu-24.04-arm
+          - platform: 'darwin/arm64'
+            runs-on: macos-15
+          - platform: 'windows/amd64'
+            runs-on: windows-2025
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@08c6903cd8c0fde910a37f88322edcfb5dd907a8 # v5.0.0
+
+      - name: Set up Python
+        uses: actions/setup-python@e797f83bcb11b83ae66e0230d6156d7c80228e7c # v6.0.0
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Set up uv
+        uses: astral-sh/setup-uv@v6
+
+      - name: Install project
+        run: |
+          uv sync
+
+      - name: Run tests
+        run: |
+          uv run python -m unittest discover -s tests -v

cypherglot-0.0.0/.gitignore

@@ -0,0 +1,207 @@
+# 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:
+*.log
+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__/