sp2react 0.1.0__tar.gz → 0.1.1__tar.gz

{sp2react-0.1.0 → sp2react-0.1.1}/CHANGELOG.md

@@ -2,6 +2,16 @@
 
 All notable changes to `sp2react` are documented here.
 
+## [0.1.1] - 2026-10-29
+
+### Added
+- End-to-end documentation in `docs/`: how it works, installation (Windows, JFrog), configuration reference, Bridger and other model providers, SQL Server / MySQL / PostgreSQL and the mapping file, a full walkthrough, command reference, the generated app and deployment, security, troubleshooting, Python API, coverage and limitations
+
+### Changed
+- `sp2react init` template and the generated `.env.example` show SQL Server connection URLs and `database.schema_name`
+- README: run the generated API with `uvicorn --env-file .env` (the app does not load `.env` by itself)
+- CI: every GitHub Action pinned to a commit SHA; Scorecard uses an existing `ossf/scorecard-action` release
+
 ## [0.1.0] - 2026-10-29
 
 First public release.

{sp2react-0.1.0/src/sp2react.egg-info → sp2react-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sp2react
-Version: 0.1.0
+Version: 0.1.1
 Summary: AI-agent pipeline that converts classic SharePoint ASPX/jQuery list forms and pages into a React + FastAPI app on your existing database
 Author: Karthikeyan Balasundaram
 License: MIT
@@ -59,10 +59,13 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 **No business data over HTTP:** in the default `database` mode, list items, attachments and people are never read from SharePoint, and every request is checked against the hosts in your config.
 
+📖 **Full documentation: [docs/](https://github.com/karthikbd/sp2react/blob/main/docs/README.md)**: installation, configuration, Bridger, SQL Server / MySQL, an end-to-end walkthrough, command reference, the generated app, security, troubleshooting.
+
 ---
 
 ## Table of Contents
 
+- [Documentation](#documentation)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
@@ -79,11 +82,28 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 ---
 
+## Documentation
+
+| Guide | |
+|---|---|
+| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/01-how-it-works.md) | stages, agents, data sources |
+| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/02-installation.md) | Windows, corporate networks (JFrog), drivers, Node.js |
+| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/03-configuration.md) | every `sp2react.yaml` key and environment variable |
+| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/04-model-provider.md) | Claude through Copilot Bridger, Anthropic, Azure OpenAI |
+| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/05-database.md) | SQL Server, MySQL, PostgreSQL; `map-db`; the mapping file; reconcile |
+| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/06-walkthrough.md) | a site from start to deployed app |
+| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/07-commands.md) | every command and option, every file written |
+| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/08-generated-app.md) | layout, settings, roles, API, tests, deployment |
+| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/09-security.md) | what is read, sent and written |
+| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/10-troubleshooting.md) | errors and fixes |
+| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/11-python-api.md) | drive sp2react from your own tool |
+| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/12-limitations.md) | what converts and what does not |
+
 ## Installation
 
 ```bash
 pip install "sp2react[mysql]"     # MySQL / MariaDB tables
-pip install "sp2react[mssql]"     # SQL Server tables
+pip install "sp2react[mssql]"     # SQL Server tables (also needs Microsoft ODBC Driver 18)
 pip install "sp2react[ntlm]"      # add for on-premises Windows authentication
 ```
 
@@ -95,7 +115,7 @@ Python 3.10+. Node.js 20+ is needed to build the generated React app.
 sp2react init                                   # writes sp2react.yaml
 export SP_USERNAME='CORP\me' SP_PASSWORD='...'  # or SP_COOKIE / SP_TOKEN
 export BRIDGER_TOKEN='...'                      # only if Bridger needs one
-export SP2REACT_DB_URL='mysql+pymysql://user:password@db-host:3306/sea'
+export SP2REACT_DB_URL='mssql+pyodbc://user:password@db-host/SEA?driver=ODBC+Driver+18+for+SQL+Server'   # or mysql+pymysql://...
 
 sp2react doctor                                 # checks SharePoint, lists Bridger's Claude models
 sp2react run --page /sites/SEA/SitePages/Dashboard.aspx --until spec
@@ -163,7 +183,7 @@ To check the earlier migration, set `security.sharepoint_item_reads: true`. `rec
 ## The generated app
 
 ```bash
-cd converted-app/backend && pip install -r requirements.txt pymysql && cp .env.example .env && uvicorn app.main:app
+cd converted-app/backend && pip install -r requirements.txt pyodbc && cp .env.example .env && uvicorn app.main:app --env-file .env
 cd converted-app/frontend && npm install && npm run dev
 ```
 

{sp2react-0.1.0 → sp2react-0.1.1}/README.md

@@ -11,10 +11,13 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 **No business data over HTTP:** in the default `database` mode, list items, attachments and people are never read from SharePoint, and every request is checked against the hosts in your config.
 
+📖 **Full documentation: [docs/](https://github.com/karthikbd/sp2react/blob/main/docs/README.md)**: installation, configuration, Bridger, SQL Server / MySQL, an end-to-end walkthrough, command reference, the generated app, security, troubleshooting.
+
 ---
 
 ## Table of Contents
 
+- [Documentation](#documentation)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
@@ -31,11 +34,28 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 ---
 
+## Documentation
+
+| Guide | |
+|---|---|
+| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/01-how-it-works.md) | stages, agents, data sources |
+| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/02-installation.md) | Windows, corporate networks (JFrog), drivers, Node.js |
+| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/03-configuration.md) | every `sp2react.yaml` key and environment variable |
+| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/04-model-provider.md) | Claude through Copilot Bridger, Anthropic, Azure OpenAI |
+| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/05-database.md) | SQL Server, MySQL, PostgreSQL; `map-db`; the mapping file; reconcile |
+| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/06-walkthrough.md) | a site from start to deployed app |
+| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/07-commands.md) | every command and option, every file written |
+| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/08-generated-app.md) | layout, settings, roles, API, tests, deployment |
+| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/09-security.md) | what is read, sent and written |
+| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/10-troubleshooting.md) | errors and fixes |
+| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/11-python-api.md) | drive sp2react from your own tool |
+| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/12-limitations.md) | what converts and what does not |
+
 ## Installation
 
 ```bash
 pip install "sp2react[mysql]"     # MySQL / MariaDB tables
-pip install "sp2react[mssql]"     # SQL Server tables
+pip install "sp2react[mssql]"     # SQL Server tables (also needs Microsoft ODBC Driver 18)
 pip install "sp2react[ntlm]"      # add for on-premises Windows authentication
 ```
 
@@ -47,7 +67,7 @@ Python 3.10+. Node.js 20+ is needed to build the generated React app.
 sp2react init                                   # writes sp2react.yaml
 export SP_USERNAME='CORP\me' SP_PASSWORD='...'  # or SP_COOKIE / SP_TOKEN
 export BRIDGER_TOKEN='...'                      # only if Bridger needs one
-export SP2REACT_DB_URL='mysql+pymysql://user:password@db-host:3306/sea'
+export SP2REACT_DB_URL='mssql+pyodbc://user:password@db-host/SEA?driver=ODBC+Driver+18+for+SQL+Server'   # or mysql+pymysql://...
 
 sp2react doctor                                 # checks SharePoint, lists Bridger's Claude models
 sp2react run --page /sites/SEA/SitePages/Dashboard.aspx --until spec
@@ -115,7 +135,7 @@ To check the earlier migration, set `security.sharepoint_item_reads: true`. `rec
 ## The generated app
 
 ```bash
-cd converted-app/backend && pip install -r requirements.txt pymysql && cp .env.example .env && uvicorn app.main:app
+cd converted-app/backend && pip install -r requirements.txt pyodbc && cp .env.example .env && uvicorn app.main:app --env-file .env
 cd converted-app/frontend && npm install && npm run dev
 ```
 

{sp2react-0.1.0 → sp2react-0.1.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "sp2react"
-version = "0.1.0"
+version = "0.1.1"
 authors = [{name = "Karthikeyan Balasundaram"}]
 description = "AI-agent pipeline that converts classic SharePoint ASPX/jQuery list forms and pages into a React + FastAPI app on your existing database"
 readme = "README.md"

{sp2react-0.1.0 → sp2react-0.1.1}/src/sp2react/__init__.py

@@ -5,7 +5,7 @@ Python API:
     p = Pipeline(load_config("sp2react.yaml"))
     p.run(pages=["SitePages/Dashboard.aspx"])
 """
-__version__ = "0.1.0"
+__version__ = "0.1.1"
 
 
 def __getattr__(name):

{sp2react-0.1.0 → sp2react-0.1.1}/src/sp2react/config.py

@@ -163,7 +163,10 @@ pipeline:
                              # sqlite: sp2react migrates the items itself | sharepoint: API uses the live lists
 
 database:
-  url_env: SP2REACT_DB_URL   # e.g. mysql+pymysql://user:password@db-host:3306/sea  (read from the environment)
+  url_env: SP2REACT_DB_URL   # read from the environment, e.g.
+                             #   mssql+pyodbc://@db-host/SEA?driver=ODBC+Driver+18+for+SQL+Server&trusted_connection=yes
+                             #   mysql+pymysql://user:password@db-host:3306/sea
+  # schema_name: dbo         # schema holding the migrated tables, if not the default
   mapping: ./db-mapping.json # drafted by `sp2react map-db`, reviewed by you
 
 security:

{sp2react-0.1.0 → sp2react-0.1.1}/src/sp2react/scaffold/generate.py

@@ -208,8 +208,9 @@ def generated_tests(specs: list[Spec], seed_counts: dict[str, int], data_source:
 
 ENV_EXAMPLE = """# Copy to .env (or set in your service configuration). Never commit real values.
 DATA_SOURCE=__SOURCE__
-# database: your existing tables
-DB_URL=mysql+pymysql://user:password@db-host:3306/sea
+# database: your existing tables (SQLAlchemy URL)
+DB_URL=mssql+pyodbc://user:password@db-host/SEA?driver=ODBC+Driver+18+for+SQL+Server
+# DB_URL=mysql+pymysql://user:password@db-host:3306/sea
 MAPPING_FILE=./mapping.json
 # auth: dev (X-User header, local only) | header (identity header from your gateway)
 AUTH_MODE=dev

{sp2react-0.1.0 → sp2react-0.1.1/src/sp2react.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: sp2react
-Version: 0.1.0
+Version: 0.1.1
 Summary: AI-agent pipeline that converts classic SharePoint ASPX/jQuery list forms and pages into a React + FastAPI app on your existing database
 Author: Karthikeyan Balasundaram
 License: MIT
@@ -59,10 +59,13 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 **No business data over HTTP:** in the default `database` mode, list items, attachments and people are never read from SharePoint, and every request is checked against the hosts in your config.
 
+📖 **Full documentation: [docs/](https://github.com/karthikbd/sp2react/blob/main/docs/README.md)**: installation, configuration, Bridger, SQL Server / MySQL, an end-to-end walkthrough, command reference, the generated app, security, troubleshooting.
+
 ---
 
 ## Table of Contents
 
+- [Documentation](#documentation)
 - [Installation](#installation)
 - [Quick Start](#quick-start)
 - [Configuration](#configuration)
@@ -79,11 +82,28 @@ Plain code does everything mechanical. AI agents (Claude through your GitHub Cop
 
 ---
 
+## Documentation
+
+| Guide | |
+|---|---|
+| [How it works](https://github.com/karthikbd/sp2react/blob/main/docs/01-how-it-works.md) | stages, agents, data sources |
+| [Installation](https://github.com/karthikbd/sp2react/blob/main/docs/02-installation.md) | Windows, corporate networks (JFrog), drivers, Node.js |
+| [Configuration reference](https://github.com/karthikbd/sp2react/blob/main/docs/03-configuration.md) | every `sp2react.yaml` key and environment variable |
+| [Model provider and Bridger](https://github.com/karthikbd/sp2react/blob/main/docs/04-model-provider.md) | Claude through Copilot Bridger, Anthropic, Azure OpenAI |
+| [Your database](https://github.com/karthikbd/sp2react/blob/main/docs/05-database.md) | SQL Server, MySQL, PostgreSQL; `map-db`; the mapping file; reconcile |
+| [End-to-end walkthrough](https://github.com/karthikbd/sp2react/blob/main/docs/06-walkthrough.md) | a site from start to deployed app |
+| [Command reference](https://github.com/karthikbd/sp2react/blob/main/docs/07-commands.md) | every command and option, every file written |
+| [The generated app](https://github.com/karthikbd/sp2react/blob/main/docs/08-generated-app.md) | layout, settings, roles, API, tests, deployment |
+| [Security](https://github.com/karthikbd/sp2react/blob/main/docs/09-security.md) | what is read, sent and written |
+| [Troubleshooting](https://github.com/karthikbd/sp2react/blob/main/docs/10-troubleshooting.md) | errors and fixes |
+| [Python API](https://github.com/karthikbd/sp2react/blob/main/docs/11-python-api.md) | drive sp2react from your own tool |
+| [Coverage and limitations](https://github.com/karthikbd/sp2react/blob/main/docs/12-limitations.md) | what converts and what does not |
+
 ## Installation
 
 ```bash
 pip install "sp2react[mysql]"     # MySQL / MariaDB tables
-pip install "sp2react[mssql]"     # SQL Server tables
+pip install "sp2react[mssql]"     # SQL Server tables (also needs Microsoft ODBC Driver 18)
 pip install "sp2react[ntlm]"      # add for on-premises Windows authentication
 ```
 
@@ -95,7 +115,7 @@ Python 3.10+. Node.js 20+ is needed to build the generated React app.
 sp2react init                                   # writes sp2react.yaml
 export SP_USERNAME='CORP\me' SP_PASSWORD='...'  # or SP_COOKIE / SP_TOKEN
 export BRIDGER_TOKEN='...'                      # only if Bridger needs one
-export SP2REACT_DB_URL='mysql+pymysql://user:password@db-host:3306/sea'
+export SP2REACT_DB_URL='mssql+pyodbc://user:password@db-host/SEA?driver=ODBC+Driver+18+for+SQL+Server'   # or mysql+pymysql://...
 
 sp2react doctor                                 # checks SharePoint, lists Bridger's Claude models
 sp2react run --page /sites/SEA/SitePages/Dashboard.aspx --until spec
@@ -163,7 +183,7 @@ To check the earlier migration, set `security.sharepoint_item_reads: true`. `rec
 ## The generated app
 
 ```bash
-cd converted-app/backend && pip install -r requirements.txt pymysql && cp .env.example .env && uvicorn app.main:app
+cd converted-app/backend && pip install -r requirements.txt pyodbc && cp .env.example .env && uvicorn app.main:app --env-file .env
 cd converted-app/frontend && npm install && npm run dev
 ```