tinycontracts 0.1.0__tar.gz → 0.1.1__tar.gz

{tinycontracts-0.1.0 → tinycontracts-0.1.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinycontracts
-Version: 0.1.0
+Version: 0.1.1
 Summary: serve a folder of json/csv/parquet files as a rest api
 Author-email: Aditya Kumar <adityakuma0308@gmail.com>
 License-Expression: MIT
@@ -29,16 +29,20 @@ Turn JSON, CSV, and Parquet files into REST APIs instantly.
 ## Install
 
 ```bash
-uv sync
+pip install tinycontracts
 ```
 
 ## Usage
 
 ```bash
-tinycontracts serve ./data
+tc ./data
 ```
 
-This scans `./data` for `.json`, `.csv`, and `.parquet` files and serves them as REST endpoints.
+Or with options:
+
+```bash
+tc ./data --port 8000 --host 0.0.0.0
+```
 
 ## Example
 
@@ -47,27 +51,43 @@ Given this structure:
 data/
   users.json
   orders.csv
-  products.parquet
+  config.json
 ```
 
 You get:
 ```
-GET /users
-GET /orders
-GET /products
+GET /users          # list all users
+GET /users/1        # get user by id
+GET /orders         # list all orders
+GET /config         # get config
+
+GET /_help          # api documentation
+GET /_schema        # all schemas
+GET /docs           # swagger ui
 ```
 
-## Filtering
+## Filtering & Pagination
 
-Query any field:
-```
-GET /users?role=admin
-GET /orders?status=shipped&customer_id=123
+```bash
+# filter by field
+curl "localhost:4242/users?active=true"
+
+# pagination
+curl "localhost:4242/orders?_limit=10&_offset=20"
+
+# sorting
+curl "localhost:4242/orders?_sort=-created_at"
+
+# combine
+curl "localhost:4242/orders?status=pending&_limit=5&_sort=-amount"
 ```
 
 ## Schema
 
-Get the inferred JSON schema:
-```
-GET /users/schema
+```bash
+# all schemas
+curl localhost:4242/_schema
+
+# single resource schema
+curl localhost:4242/users/_schema
 ```

tinycontracts-0.1.1/README.md

@@ -0,0 +1,69 @@
+# tinycontracts
+
+Turn JSON, CSV, and Parquet files into REST APIs instantly.
+
+## Install
+
+```bash
+pip install tinycontracts
+```
+
+## Usage
+
+```bash
+tc ./data
+```
+
+Or with options:
+
+```bash
+tc ./data --port 8000 --host 0.0.0.0
+```
+
+## Example
+
+Given this structure:
+```
+data/
+  users.json
+  orders.csv
+  config.json
+```
+
+You get:
+```
+GET /users          # list all users
+GET /users/1        # get user by id
+GET /orders         # list all orders
+GET /config         # get config
+
+GET /_help          # api documentation
+GET /_schema        # all schemas
+GET /docs           # swagger ui
+```
+
+## Filtering & Pagination
+
+```bash
+# filter by field
+curl "localhost:4242/users?active=true"
+
+# pagination
+curl "localhost:4242/orders?_limit=10&_offset=20"
+
+# sorting
+curl "localhost:4242/orders?_sort=-created_at"
+
+# combine
+curl "localhost:4242/orders?status=pending&_limit=5&_sort=-amount"
+```
+
+## Schema
+
+```bash
+# all schemas
+curl localhost:4242/_schema
+
+# single resource schema
+curl localhost:4242/users/_schema
+```

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

@@ -1,6 +1,6 @@
 [project]
 name = "tinycontracts"
-version = "0.1.0"
+version = "0.1.1"
 description = "serve a folder of json/csv/parquet files as a rest api"
 readme = "README.md"
 requires-python = ">=3.11"

{tinycontracts-0.1.0 → tinycontracts-0.1.1}/tinycontracts/cli.py

@@ -25,7 +25,7 @@ def print_banner(host: str, port: int, resources: list[str], folder: Path):
     console.print()
     console.print(
         Panel.fit(
-            "[bold cyan]tinycontracts[/bold cyan]  [dim]v0.1.0[/dim]",
+            "[bold cyan]tinycontracts[/bold cyan]  [dim]v0.1.1[/dim]",
             border_style="cyan",
         )
     )
@@ -127,7 +127,7 @@ def serve(
 @app.command()
 def version():
     """show version"""
-    console.print("tinycontracts [cyan]v0.1.0[/cyan]")
+    console.print("tinycontracts [cyan]v0.1.1[/cyan]")
 
 
 if __name__ == "__main__":

tinycontracts-0.1.0/README.md

@@ -1,49 +0,0 @@
-# tinycontracts
-
-Turn JSON, CSV, and Parquet files into REST APIs instantly.
-
-## Install
-
-```bash
-uv sync
-```
-
-## Usage
-
-```bash
-tinycontracts serve ./data
-```
-
-This scans `./data` for `.json`, `.csv`, and `.parquet` files and serves them as REST endpoints.
-
-## Example
-
-Given this structure:
-```
-data/
-  users.json
-  orders.csv
-  products.parquet
-```
-
-You get:
-```
-GET /users
-GET /orders
-GET /products
-```
-
-## Filtering
-
-Query any field:
-```
-GET /users?role=admin
-GET /orders?status=shipped&customer_id=123
-```
-
-## Schema
-
-Get the inferred JSON schema:
-```
-GET /users/schema
-```