cinchdb 0.1.0__tar.gz

cinchdb-0.1.0/.gitignore

@@ -0,0 +1,69 @@
+# Python
+__pycache__/
+*.py[cod]
+*$py.class
+*.so
+.Python
+env/
+venv/
+ENV/
+.env
+.venv
+dist/
+build/
+*.egg-info/
+.pytest_cache/
+.mypy_cache/
+.coverage
+htmlcov/
+.tox/
+.ruff_cache/
+
+# Node
+node_modules/
+npm-debug.log*
+yarn-debug.log*
+yarn-error.log*
+.pnpm-debug.log*
+.next/
+out/
+.turbo/
+
+# IDE
+.vscode/
+.idea/
+*.swp
+*.swo
+*~
+.DS_Store
+
+# CinchDB specific
+.cinchdb/
+*.db
+*.db-wal
+*.db-shm
+
+# Claude memory (keep in repo)
+# .claude-memory/
+
+# Temporary files
+*.tmp
+*.bak
+.cache/
+
+# Documentation build
+docs/.next/
+docs/out/
+
+# TypeScript
+*.tsbuildinfo
+sdk/typescript/dist/
+
+# Testing
+coverage/
+.nyc_output/
+
+# OS
+Thumbs.db
+
+site/

cinchdb-0.1.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

cinchdb-0.1.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: cinchdb
+Version: 0.1.0
+Summary: A Git-like SQLite database management system with branching and multi-tenancy
+Project-URL: Homepage, https://github.com/russellromney/cinchdb
+Project-URL: Documentation, https://russellromney.github.io/cinchdb
+Project-URL: Repository, https://github.com/russellromney/cinchdb
+Project-URL: Issues, https://github.com/russellromney/cinchdb/issues
+Author: Russell Romney
+License: MIT
+License-File: LICENSE
+Keywords: branching,database,git,multi-tenant,sqlite
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Requires-Dist: fastapi>=0.115.0
+Requires-Dist: pydantic>=2.0.0
+Requires-Dist: python-multipart>=0.0.12
+Requires-Dist: requests>=2.28.0
+Requires-Dist: rich>=13.0.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: typer>=0.9.0
+Requires-Dist: uvicorn>=0.32.0
+Description-Content-Type: text/markdown
+
+# CinchDB
+
+**Git-like SQLite database management with branching and multi-tenancy**
+
+NOTE: CinchDB is in early alpha. This is project to test out an idea. Do not use this in production.
+
+CinchDB is for projects that need to isolate data per-tenant [or even per-user](https://turso.tech/blog/give-each-of-your-users-their-own-sqlite-database-b74445f4) and/or want to test out changes to structure safely in branchces. Plus, queries can be super, super fast because data is separated per tenant so it's <data_size>/<n_tenants> instead of <data_size>
+
+On a meta level, I made this because I wanted a database structure that I felt comfortable letting AI agents take full control over, safely, and I didn't want to run my own Postgres instance somewhere or pay for it on e.g. Neon - I don't need hyperscaling, I just need super fast queries.
+
+Because it's so lightweight and its only dependencies are FastAPI, pydantic, requests, and Typer, it is super cheap to run on a small VM like from [Fly.io](https://fly.io) and I don't need to SSH into it to connect - I can just store an API key in my local projects. 
+
+
+```bash
+uv pip install cinchdb
+
+# Initialize project
+cinch init 
+
+# Create and query tables
+cinch table create users name:TEXT email:TEXT
+cinch query "SELECT * FROM users"
+
+# Git-like branching
+cinch branch create feature
+cinch branch switch feature
+cinch table create products name:TEXT price:REAL
+cinch branch merge-into-main feature
+
+# Multi-tenant support
+cinch tenant create customer_a
+cinch query "SELECT * FROM users" --tenant customer_a
+
+# API server
+uv pip install cinchdb[server]
+cinch-server serve
+
+# Autogenerate Python SDK from database
+cinch codegen generate python cinchdb_models/
+```
+
+## What is CinchDB?
+
+CinchDB combines SQLite with Git-like workflows for database schema management:
+
+- **Branch schemas** like code - create feature branches, make changes, merge back
+- **Multi-tenant isolation** - shared schema, isolated data per tenant
+- **Automatic change tracking** - all schema changes tracked and mergeable
+- **Safe structure changes** - change merges happen atomically with zero rollback risk (seriously)
+- **Remote deployment** - FastAPI server with UUID authentication
+- **Type-safe SDK** - Python and TypeScript SDKs with full type safety
+- **API server for remote hosting** - Useful for running many web projects
+- **SDK generation from database schema** - Generate a typesafe SDK from your database models for CRUD operations
+
+## Installation
+
+Requires Python 3.10+:
+
+```bash
+pip install cinchdb
+```
+
+## Quick Start
+
+### CLI Usage
+
+```bash
+# Initialize project
+cinch init my_app
+cd my_app
+
+# Create schema on feature branch
+cinch branch create user-system
+cinch table create users username:TEXT email:TEXT
+cinch view create active_users "SELECT * FROM users WHERE created_at > datetime('now', '-30 days')"
+
+# Merge to main
+cinch branch merge-into-main user-system
+
+# Multi-tenant operations
+cinch tenant create customer_a
+cinch tenant create customer_b
+cinch query "SELECT COUNT(*) FROM users" --tenant customer_a
+```
+
+### Python SDK
+
+```python
+import cinchdb
+from cinchdb.models import Column
+
+# Local connection
+db = cinchdb.connect("myapp")
+
+# Create schema
+db.create_table("posts", [
+    Column(name="title", type="TEXT",nullable=False),
+    Column(name="content", type="TEXT")
+])
+
+# Query data
+results = db.query("SELECT * FROM posts WHERE title LIKE ?", ["%python%"])
+
+# CRUD operations
+post_id = db.insert("posts", {"title": "Hello World", "content": "First post"})
+db.update("posts", post_id, {"content": "Updated content"})
+```
+
+### Remote API
+
+```python
+# Connect to remote API
+db = cinchdb.connect_api("https://api.example.com", "your-api-key", "myapp")
+
+# Same interface as local
+results = db.query("SELECT * FROM users")
+user_id = db.insert("users", {"username": "alice", "email": "alice@example.com"})
+```
+
+## API Server
+
+Start the server:
+
+```bash
+cinch-server serve --create-key
+# Creates API key (works after shutdown as well) and starts server on http://localhost:8000
+```
+
+Interactive docs at `/docs`, health check at `/health`.
+
+## Architecture
+
+- **Python SDK**: Core functionality (local + remote)
+- **CLI**: Full-featured command-line interface  
+- **FastAPI Server**: REST API with authentication
+- **TypeScript SDK**: Browser and Node.js client
+
+## Development
+
+```bash
+git clone https://github.com/russellromney/cinchdb.git
+cd cinchdb
+make install-all
+make test
+```
+
+## Future
+
+Though probably not, perhaps I'll evolve it into something bigger and more full-featured, with things like
+- data backups
+- replication to S3
+- audit access
+- SaaS-like dynamics
+- multi-project hosting
+- auth proxying
+- leader-follower abilities for edge deployment
+
+
+## License
+
+Apache 2.0 - see [LICENSE](LICENSE)
+
+---
+
+**CinchDB** - Database management as easy as version control

cinchdb-0.1.0/README.md

@@ -0,0 +1,165 @@
+# CinchDB
+
+**Git-like SQLite database management with branching and multi-tenancy**
+
+NOTE: CinchDB is in early alpha. This is project to test out an idea. Do not use this in production.
+
+CinchDB is for projects that need to isolate data per-tenant [or even per-user](https://turso.tech/blog/give-each-of-your-users-their-own-sqlite-database-b74445f4) and/or want to test out changes to structure safely in branchces. Plus, queries can be super, super fast because data is separated per tenant so it's <data_size>/<n_tenants> instead of <data_size>
+
+On a meta level, I made this because I wanted a database structure that I felt comfortable letting AI agents take full control over, safely, and I didn't want to run my own Postgres instance somewhere or pay for it on e.g. Neon - I don't need hyperscaling, I just need super fast queries.
+
+Because it's so lightweight and its only dependencies are FastAPI, pydantic, requests, and Typer, it is super cheap to run on a small VM like from [Fly.io](https://fly.io) and I don't need to SSH into it to connect - I can just store an API key in my local projects. 
+
+
+```bash
+uv pip install cinchdb
+
+# Initialize project
+cinch init 
+
+# Create and query tables
+cinch table create users name:TEXT email:TEXT
+cinch query "SELECT * FROM users"
+
+# Git-like branching
+cinch branch create feature
+cinch branch switch feature
+cinch table create products name:TEXT price:REAL
+cinch branch merge-into-main feature
+
+# Multi-tenant support
+cinch tenant create customer_a
+cinch query "SELECT * FROM users" --tenant customer_a
+
+# API server
+uv pip install cinchdb[server]
+cinch-server serve
+
+# Autogenerate Python SDK from database
+cinch codegen generate python cinchdb_models/
+```
+
+## What is CinchDB?
+
+CinchDB combines SQLite with Git-like workflows for database schema management:
+
+- **Branch schemas** like code - create feature branches, make changes, merge back
+- **Multi-tenant isolation** - shared schema, isolated data per tenant
+- **Automatic change tracking** - all schema changes tracked and mergeable
+- **Safe structure changes** - change merges happen atomically with zero rollback risk (seriously)
+- **Remote deployment** - FastAPI server with UUID authentication
+- **Type-safe SDK** - Python and TypeScript SDKs with full type safety
+- **API server for remote hosting** - Useful for running many web projects
+- **SDK generation from database schema** - Generate a typesafe SDK from your database models for CRUD operations
+
+## Installation
+
+Requires Python 3.10+:
+
+```bash
+pip install cinchdb
+```
+
+## Quick Start
+
+### CLI Usage
+
+```bash
+# Initialize project
+cinch init my_app
+cd my_app
+
+# Create schema on feature branch
+cinch branch create user-system
+cinch table create users username:TEXT email:TEXT
+cinch view create active_users "SELECT * FROM users WHERE created_at > datetime('now', '-30 days')"
+
+# Merge to main
+cinch branch merge-into-main user-system
+
+# Multi-tenant operations
+cinch tenant create customer_a
+cinch tenant create customer_b
+cinch query "SELECT COUNT(*) FROM users" --tenant customer_a
+```
+
+### Python SDK
+
+```python
+import cinchdb
+from cinchdb.models import Column
+
+# Local connection
+db = cinchdb.connect("myapp")
+
+# Create schema
+db.create_table("posts", [
+    Column(name="title", type="TEXT",nullable=False),
+    Column(name="content", type="TEXT")
+])
+
+# Query data
+results = db.query("SELECT * FROM posts WHERE title LIKE ?", ["%python%"])
+
+# CRUD operations
+post_id = db.insert("posts", {"title": "Hello World", "content": "First post"})
+db.update("posts", post_id, {"content": "Updated content"})
+```
+
+### Remote API
+
+```python
+# Connect to remote API
+db = cinchdb.connect_api("https://api.example.com", "your-api-key", "myapp")
+
+# Same interface as local
+results = db.query("SELECT * FROM users")
+user_id = db.insert("users", {"username": "alice", "email": "alice@example.com"})
+```
+
+## API Server
+
+Start the server:
+
+```bash
+cinch-server serve --create-key
+# Creates API key (works after shutdown as well) and starts server on http://localhost:8000
+```
+
+Interactive docs at `/docs`, health check at `/health`.
+
+## Architecture
+
+- **Python SDK**: Core functionality (local + remote)
+- **CLI**: Full-featured command-line interface  
+- **FastAPI Server**: REST API with authentication
+- **TypeScript SDK**: Browser and Node.js client
+
+## Development
+
+```bash
+git clone https://github.com/russellromney/cinchdb.git
+cd cinchdb
+make install-all
+make test
+```
+
+## Future
+
+Though probably not, perhaps I'll evolve it into something bigger and more full-featured, with things like
+- data backups
+- replication to S3
+- audit access
+- SaaS-like dynamics
+- multi-project hosting
+- auth proxying
+- leader-follower abilities for edge deployment
+
+
+## License
+
+Apache 2.0 - see [LICENSE](LICENSE)
+
+---
+
+**CinchDB** - Database management as easy as version control