Refactor to make library installable as module (#42)

Author: plutasnyy

.github/workflows/ci.yml

@@ -0,0 +1,44 @@
+name: CI
+
+on:
+  pull_request
+
+jobs:
+  pre-commit:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install pre-commit
+        run: pip install pre-commit
+
+      - name: Run pre-commit
+        run: pre-commit run --all-files
+
+  tests:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v5
+        with:
+          enable-cache: true
+
+      - name: Set up Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: '3.12'
+
+      - name: Install dependencies
+        run: |
+          uv sync --all-extras
+
+      - name: Run tests
+        run: make test-firecrawl

.github/workflows/release.yml

@@ -0,0 +1,59 @@
+name: Release
+
+on:
+  push:
+    branches: [main]
+  workflow_dispatch:
+
+env:
+  PYTHONVERSION: "3.12"
+
+jobs:
+  release:
+    runs-on: macos-latest
+
+    steps:
+      - name: Check out the repo
+        uses: actions/checkout@v4
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python and Install dependencies
+        if: env.SKIP_RELEASE != 'true'
+        run: |
+          uv python install ${{ env.PYTHONVERSION }}
+          uv venv
+          uv pip install .
+          uv pip install twine build toml
+
+      - name: Get version from main
+        id: get-main-version
+        run: |
+          git switch main
+          MAIN_VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+          echo "MAIN_VERSION=$MAIN_VERSION" >> $GITHUB_ENV
+          git switch -
+
+      - name: Compare versions
+        id: compare-versions
+        run: |
+          CUR_VERSION=$(python -c "import toml; print(toml.load('pyproject.toml')['project']['version'])")
+
+          echo "Current version in pyproject.toml: $CUR_VERSION"
+          echo "Version on main branch: $MAIN_VERSION"
+
+          if [ "$CUR_VERSION" == "$MAIN_VERSION" ]; then
+            echo "The version hasn't changed. Skipping release."
+            echo "SKIP_RELEASE=true" >> $GITHUB_ENV
+          else
+            echo "Versions differ. Proceed with the release."
+            echo "SKIP_RELEASE=false" >> $GITHUB_ENV
+
+      - name: Release to PyPI
+        if: env.SKIP_RELEASE != 'true'
+        env:
+          TWINE_USERNAME: "__token__"
+          TWINE_PASSWORD: ${{ secrets.PRIVATE_PYPI_PUBLISHER_TOKEN }}
+        run: |
+          uv run python -m build --sdist
+          uv run twine upload -r pypi dist/*

.gitignore

@@ -5,3 +5,4 @@
 *.ipynb_checkpoints*
 build
 .idea
+dist

CHANGELOG.md

@@ -1,9 +1,11 @@
-## 0.1.2-dev
+## 0.1.2
 
 ### Enhancements
 
-- Ability to run the minimal client and server separately (relies on the HTTP SSE interaface)
+- Ability to run the minimal client and server separately (relies on the HTTP SSE interface)
+
 - Neo4j Username is now ENV variable instead of being tool argument
+
 - Added notebook with example workflow having Azure source and Neo4j destination
 
 - **Destination connector adding**: MongoDB, Databricks Volumes, Databricks Volumes Delta Table, Pinecone
@@ -16,6 +18,8 @@
 
 - Adds terminal access to the minimal client using DesktopCommanderMCP
 
+- UNS-MCP server can be installed as standalone package, thus the usage of it is simplified for non-dev users
+
 ### Fixes
 
 - avoid client startup error if env not defined

MANIFEST.in

@@ -0,0 +1,5 @@
+graft uns_mcp
+prune notebooks
+prune minimal_client
+prune tests
+global-exclude *.py[cod] __pycache__/* *.egg-info/*

Makefile

@@ -8,7 +8,7 @@ sse-client:
 
 
 .PHONY: sse-client-terminal
-sse-client:
+sse-client-terminal:
 	uv run python minimal_client/client.py "http://127.0.0.1:8080/sse" "@wonderwhy-er/desktop-commander"
 
 .PHONY: sse-server