before open sourcing repo

.gitignore

@@ -0,0 +1,132 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+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/
+
+# 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
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.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
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.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/
+
+# .vscode
+.vscode/

README.md

@@ -1,2 +1,210 @@
-# workflows-cdk
-Workflows Connector Development Kit
+# Workflows CDK
+
+A powerful CDK (Connector Development Kit) for building Stacksync Workflows Connectors with Python and Flask.
+
+## Features
+
+- 🚀 Automatic route discovery and registration file based (like in Next.js!)
+- 🔒 Built-in error handling and Sentry integration
+- 📦 Standardized request/response handling
+- 🛠️ Error management with standardized error handling
+- 🔄 Environment-aware configuration
+
+## Installation
+
+```bash
+pip install workflows-cdk
+```
+
+## Quick Start
+
+1. Create a new project directory:
+
+```bash
+mkdir my-workflow-connector
+cd my-workflow-connector
+```
+
+2. Install the required dependencies:
+
+```bash
+pip install workflows-cdk flask pyyaml
+```
+
+3. Create the basic project structure:
+
+```
+my-workflow-connector/
+├── main.py
+├── app_config.yaml
+├── requirements.txt
+└── routes/
+    └── hello/
+        └── v1/
+            └── route.py
+```
+
+4. Set up your `app_config.yaml`:
+
+```yaml
+app_settings:
+  app_type: "example"
+  app_name: "My Workflow Connector"
+  app_description: "A simple workflow connector"
+  sentry_dsn: "your-sentry-dsn" # Optional
+  cors_origins: ["*"]
+  routes_directory: "routes"
+  debug: true
+  host: "0.0.0.0"
+  port: 2005
+```
+
+5. Create your `main.py`:
+
+```python
+from flask import Flask
+from workflows_cdk import Router
+
+# Create Flask app
+app = Flask("my-workflow-connector")
+
+# Initialize router with configuration
+router = Router(app)
+
+# Run the app
+if __name__ == "__main__":
+    router.run_app(app)
+```
+
+6. Create your first route in `routes/send_message/v1/route.py`:
+
+```python
+from workflows_cdk import Request, Response, ManagedError
+from main import router
+
+@router.route("/execute", methods=["POST"])
+def execute():
+    """Execute the send message action."""
+    request = Request(flask_request)
+    data = request.data
+
+    name = data.get("name", "World")
+    return Response.success(data={
+        "message": f"Hello, {name}!"
+    })
+```
+
+## Core Components
+
+### Router
+
+The `Router` class is the heart of the CDK, providing:
+
+- Automatic route discovery based on file system structure
+- Built-in error handling and Sentry integration
+- CORS configuration
+- Health check endpoints
+- API documentation
+
+### Request
+
+The `Request` class wraps Flask's request object, providing:
+
+- Easy access to request data and credentials
+- Automatic JSON parsing
+- Type-safe access to common properties
+
+### Response
+
+The `Response` class provides standardized response formatting:
+
+- Success responses with optional metadata
+- Error responses with appropriate status codes
+- Environment-aware error details
+- Sentry integration
+
+### ManagedError
+
+The `ManagedError` class provides structured error handling:
+
+- Type-safe error creation
+- Automatic Sentry reporting
+- Environment-aware error details
+- Common error types (validation, not found, unauthorized, etc.)
+
+## Project Structure
+
+Recommended project structure for a workflow connector:
+
+```
+my-workflow-connector/
+├── main.py                 # Application entry point
+├── app_config.yaml         # Application configuration
+├── requirements.txt        # Python dependencies
+├── README.md              # Project documentation
+├── Dockerfile             # Container configuration
+├── .env                   # Environment variables
+└── routes/                # Route modules
+    └── action_name/       # Group routes by action
+        ├── v1/            # Version 1 of the action
+        │   ├── route.py   # Route implementation
+        │   └── schema.json # JSON Schema for validation
+        └── v2/            # Version 2 of the action
+            ├── route.py
+            └── schema.json
+```
+
+## Error Handling
+
+The CDK provides comprehensive error handling:
+
+```python
+from workflows_cdk import ManagedError
+
+# Validation error
+raise ManagedError.validation_error(
+    error="Invalid input",
+    data={"field": "email"}
+)
+
+# Not found error
+raise ManagedError.not_found(
+    resource="User",
+    identifier="123"
+)
+
+# Authorization error
+raise ManagedError.unauthorized(
+    message="Invalid API key"
+)
+
+# Server error
+raise ManagedError.server_error(
+    error="Database connection failed"
+)
+```
+
+## Response Formatting
+
+Standardized response formatting:
+
+```python
+from workflows_cdk import Response
+
+# Success response
+return Response.success(
+    data={"result": "ok"},
+    message="Operation completed",
+    metadata={"timestamp": "2024-02-17"}
+)
+
+# Error response
+return Response.error(
+    error="Something went wrong",
+    status_code=400
+)
+```
+
+## License
+
+This project is licensed under the Stacksync Connector License (SCL) v1.0.

requirements.txt

@@ -0,0 +1,10 @@
+flask
+werkzeug
+pyopenssl==24.1.0
+flask-cors>=4.0.0
+python-dotenv>=1.0.0
+gunicorn==22.0.0
+authlib==1.1.0
+sentry-sdk[Flask]
+pydantic>=2.0.0
+pyyaml>=6.0.0

setup.py

@@ -0,0 +1,30 @@
+"""
+Setup configuration for workflows-cdk package.
+"""
+
+from setuptools import find_packages, setup
+
+
+setup(
+    name="workflows_cdk",
+    version="0.1.0",
+    description="A CDK for developing Stacksync Workflows Connectors",
+    author="Stacksync",
+    author_email="oliviero@stacksync.com",
+    install_requires=[
+        # Core dependencies
+        "flask",
+        "werkzeug==2.2",
+        "pyopenssl==24.1.0",
+        "flask-cors>=4.0.0",
+        "python-dotenv>=1.0.0",
+        "gunicorn==22.0.0",
+        "sentry-sdk[Flask]",
+        "pydantic>=2.0.0",
+        "pyyaml>=6.0.0"
+    ],
+    python_requires=">=3.10",
+    packages=find_packages(where="src"),
+    package_dir={"": "src"},
+    include_package_data=True,
+)

src/__init__.py

@@ -0,0 +1,2 @@
+from .workflows_cdk import *
+