tinycontracts 0.1.1__tar.gz → 0.1.2__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinycontracts
-Version: 0.1.1
+Version: 0.1.2
 Summary: serve a folder of json/csv/parquet files as a rest api
 Author-email: Aditya Kumar <adityakuma0308@gmail.com>
 License-Expression: MIT
@@ -24,7 +24,7 @@ Description-Content-Type: text/markdown
 
 # tinycontracts
 
-Turn JSON, CSV, and Parquet files into REST APIs instantly.
+Turn any folder of JSON, CSV, or Parquet files into a REST API instantly.
 
 ## Install
 
@@ -38,56 +38,48 @@ pip install tinycontracts
 tc ./data
 ```
 
-Or with options:
+That's it. Your files are now API endpoints.
+
+## Options
 
 ```bash
-tc ./data --port 8000 --host 0.0.0.0
+tc ./data -p 8000           # custom port (default: 4242)
+tc ./data -H 0.0.0.0        # expose to network
+tc --version                # show version
 ```
 
 ## 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
+  users.json     ->  GET /users
+  orders.csv     ->  GET /orders
+  config.json    ->  GET /config
 ```
 
-## Filtering & Pagination
+## Querying
 
 ```bash
-# filter by field
+# filter
 curl "localhost:4242/users?active=true"
 
 # pagination
 curl "localhost:4242/orders?_limit=10&_offset=20"
 
-# sorting
+# sort
 curl "localhost:4242/orders?_sort=-created_at"
 
 # combine
-curl "localhost:4242/orders?status=pending&_limit=5&_sort=-amount"
+curl "localhost:4242/orders?status=pending&_limit=5"
 ```
 
-## Schema
+## Endpoints
 
-```bash
-# all schemas
-curl localhost:4242/_schema
-
-# single resource schema
-curl localhost:4242/users/_schema
-```
+| Endpoint | Description |
+|----------|-------------|
+| `/{resource}` | List all rows |
+| `/{resource}/{id}` | Get by ID |
+| `/{resource}/_schema` | JSON schema |
+| `/_help` | API documentation |
+| `/_schema` | All schemas |
+| `/docs` | Swagger UI |

tinycontracts-0.1.2/README.md

@@ -0,0 +1,61 @@
+# tinycontracts
+
+Turn any folder of JSON, CSV, or Parquet files into a REST API instantly.
+
+## Install
+
+```bash
+pip install tinycontracts
+```
+
+## Usage
+
+```bash
+tc ./data
+```
+
+That's it. Your files are now API endpoints.
+
+## Options
+
+```bash
+tc ./data -p 8000           # custom port (default: 4242)
+tc ./data -H 0.0.0.0        # expose to network
+tc --version                # show version
+```
+
+## Example
+
+```
+data/
+  users.json     ->  GET /users
+  orders.csv     ->  GET /orders
+  config.json    ->  GET /config
+```
+
+## Querying
+
+```bash
+# filter
+curl "localhost:4242/users?active=true"
+
+# pagination
+curl "localhost:4242/orders?_limit=10&_offset=20"
+
+# sort
+curl "localhost:4242/orders?_sort=-created_at"
+
+# combine
+curl "localhost:4242/orders?status=pending&_limit=5"
+```
+
+## Endpoints
+
+| Endpoint | Description |
+|----------|-------------|
+| `/{resource}` | List all rows |
+| `/{resource}/{id}` | Get by ID |
+| `/{resource}/_schema` | JSON schema |
+| `/_help` | API documentation |
+| `/_schema` | All schemas |
+| `/docs` | Swagger UI |

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

@@ -1,6 +1,6 @@
 [project]
 name = "tinycontracts"
-version = "0.1.1"
+version = "0.1.2"
 description = "serve a folder of json/csv/parquet files as a rest api"
 readme = "README.md"
 requires-python = ">=3.11"
@@ -29,7 +29,7 @@ dependencies = [
 ]
 
 [project.scripts]
-tc = "tinycontracts.cli:app"
+tc = "tinycontracts.cli:main"
 
 [build-system]
 requires = ["hatchling"]

tinycontracts-0.1.2/tinycontracts/cli.py

@@ -0,0 +1,153 @@
+# cli.py - fast startup with lazy imports
+import sys
+
+
+def main():
+    # fast path for --help and --version (no heavy imports)
+    args = sys.argv[1:]
+
+    if not args or args[0] in ("--help", "-h"):
+        print("""tc - serve data files as a rest api
+
+usage: tc <folder> [options]
+
+arguments:
+  folder              folder containing json/csv/parquet files
+
+options:
+  -p, --port PORT     port to serve on (default: 4242)
+  -H, --host HOST     host to bind to (default: 127.0.0.1)
+  -v, --version       show version
+  -h, --help          show this help""")
+        return
+
+    if args[0] in ("--version", "-v"):
+        print("tinycontracts v0.1.2")
+        return
+
+    # parse args manually for fast path
+    path = None
+    port = 4242
+    host = "127.0.0.1"
+
+    i = 0
+    while i < len(args):
+        arg = args[i]
+        if arg in ("-p", "--port"):
+            port = int(args[i + 1])
+            i += 2
+        elif arg in ("-H", "--host"):
+            host = args[i + 1]
+            i += 2
+        elif arg.startswith("-"):
+            print(f"error: unknown option {arg}")
+            sys.exit(1)
+        else:
+            path = arg
+            i += 1
+
+    if not path:
+        print("error: missing folder path\nusage: tc <folder>")
+        sys.exit(1)
+
+    # now import heavy deps
+    from pathlib import Path
+    from rich.console import Console
+
+    console = Console()
+    folder = Path(path)
+
+    if not folder.exists():
+        console.print(f"\n  [red]error:[/red] path not found: [bold]{folder}[/bold]")
+        console.print("  [dim]make sure the path exists and try again[/dim]\n")
+        sys.exit(1)
+
+    if not folder.is_dir():
+        console.print(f"\n  [red]error:[/red] not a folder: [bold]{folder}[/bold]")
+        console.print("  [dim]tc needs a folder path, not a file[/dim]\n")
+        sys.exit(1)
+
+    data_files = (
+        list(folder.glob("*.json"))
+        + list(folder.glob("*.csv"))
+        + list(folder.glob("*.parquet"))
+    )
+    if not data_files:
+        console.print(
+            f"\n  [yellow]warning:[/yellow] no data files in [bold]{folder}[/bold]"
+        )
+        console.print("  [dim]add .json, .csv, or .parquet files[/dim]\n")
+
+    # lazy import heavy deps with spinner
+    with console.status("[cyan]loading...[/cyan]", spinner="dots"):
+        from tinycontracts.server import create_app
+        import uvicorn
+
+        try:
+            fastapi_app = create_app(folder)
+            resources = (
+                list(fastapi_app.state.resources.keys())
+                if hasattr(fastapi_app.state, "resources")
+                else []
+            )
+        except PermissionError:
+            console.print(f"\n  [red]error:[/red] permission denied: [bold]{folder}[/bold]")
+            console.print("  [dim]check file permissions and try again[/dim]\n")
+            sys.exit(1)
+        except Exception as e:
+            console.print(f"\n  [red]error:[/red] failed to load data: {e}\n")
+            sys.exit(1)
+
+    # print banner
+    from rich.panel import Panel
+    from rich.table import Table
+
+    console.print()
+    console.print(
+        Panel.fit(
+            "[bold cyan]tinycontracts[/bold cyan]  [dim]v0.1.2[/dim]",
+            border_style="cyan",
+        )
+    )
+    console.print()
+
+    console.print(f"  [dim]folder:[/dim]  {folder.resolve()}")
+    console.print(f"  [dim]server:[/dim]  [green]http://{host}:{port}[/green]")
+    console.print()
+
+    if resources:
+        table = Table(show_header=True, header_style="bold", box=None, padding=(0, 2))
+        table.add_column("endpoint", style="green")
+        table.add_column("description", style="dim")
+
+        for name in sorted(resources):
+            table.add_row(f"/{name}", f"query {name}")
+
+        table.add_row("", "")
+        table.add_row("/docs", "swagger ui")
+        table.add_row("/_help", "api help")
+
+        console.print(table)
+    else:
+        console.print("  [yellow]no data files found[/yellow]")
+
+    console.print()
+    console.print("  [dim]press ctrl+c to stop[/dim]")
+    console.print()
+
+    # run server
+    try:
+        uvicorn.run(fastapi_app, host=host, port=port, log_level="warning")
+    except KeyboardInterrupt:
+        console.print("\n  [dim]stopped[/dim]\n")
+    except OSError as e:
+        if "address already in use" in str(e).lower() or "10048" in str(e):
+            console.print(f"\n  [red]error:[/red] port {port} already in use")
+            console.print(f"  [dim]try: tc {path} -p {port + 1}[/dim]\n")
+        else:
+            console.print(f"\n  [red]error:[/red] {e}\n")
+        sys.exit(1)
+
+
+if __name__ == "__main__":
+    main()

{tinycontracts-0.1.1 → tinycontracts-0.1.2}/uv.lock

@@ -484,7 +484,7 @@ wheels = [
 
 [[package]]
 name = "tinycontracts"
-version = "0.1.0"
+version = "0.1.2"
 source = { editable = "." }
 dependencies = [
     { name = "fastapi" },

tinycontracts-0.1.1/README.md

@@ -1,69 +0,0 @@
-# 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.1/tinycontracts/cli.py

@@ -1,134 +0,0 @@
-# cli.py - typer entry point
-import sys
-from pathlib import Path
-
-import typer
-import uvicorn
-from rich.console import Console
-from rich.panel import Panel
-from rich.table import Table
-
-from tinycontracts.server import create_app
-
-console = Console()
-
-app = typer.Typer(
-    name="tc",
-    help="serve a folder of json/csv/parquet files as a rest api",
-    no_args_is_help=True,
-    add_completion=False,
-)
-
-
-def print_banner(host: str, port: int, resources: list[str], folder: Path):
-    # header
-    console.print()
-    console.print(
-        Panel.fit(
-            "[bold cyan]tinycontracts[/bold cyan]  [dim]v0.1.1[/dim]",
-            border_style="cyan",
-        )
-    )
-    console.print()
-
-    # server info
-    console.print(f"  [dim]folder:[/dim]  {folder.resolve()}")
-    console.print(f"  [dim]server:[/dim]  [green]http://{host}:{port}[/green]")
-    console.print()
-
-    # endpoints table
-    if resources:
-        table = Table(show_header=True, header_style="bold", box=None, padding=(0, 2))
-        table.add_column("endpoint", style="green")
-        table.add_column("description", style="dim")
-
-        for name in sorted(resources):
-            table.add_row(f"/{name}", f"query {name}")
-
-        table.add_row("", "")
-        table.add_row("/docs", "swagger ui")
-        table.add_row("/_help", "api help")
-
-        console.print(table)
-    else:
-        console.print("  [yellow]no data files found[/yellow]")
-
-    console.print()
-    console.print("  [dim]press ctrl+c to stop[/dim]")
-    console.print()
-
-
-@app.command()
-def serve(
-    path: str = typer.Argument(..., help="folder containing data files"),
-    port: int = typer.Option(4242, "--port", "-p", help="port to serve on"),
-    host: str = typer.Option("127.0.0.1", "--host", "-H", help="host to bind to"),
-):
-    """serve data files as a rest api"""
-    folder = Path(path)
-
-    # validate folder exists
-    if not folder.exists():
-        console.print(f"\n  [red]error:[/red] path not found: [bold]{folder}[/bold]")
-        console.print(f"  [dim]make sure the path exists and try again[/dim]\n")
-        raise typer.Exit(1)
-
-    # validate it's a directory
-    if not folder.is_dir():
-        console.print(f"\n  [red]error:[/red] not a folder: [bold]{folder}[/bold]")
-        console.print(f"  [dim]tc needs a folder path, not a file[/dim]\n")
-        raise typer.Exit(1)
-
-    # check for data files
-    data_files = (
-        list(folder.glob("*.json"))
-        + list(folder.glob("*.csv"))
-        + list(folder.glob("*.parquet"))
-    )
-    if not data_files:
-        console.print(
-            f"\n  [yellow]warning:[/yellow] no data files in [bold]{folder}[/bold]"
-        )
-        console.print("[dim]add .json, .csv, or .parquet files[/dim]\n")
-
-    # create app
-    try:
-        fastapi_app = create_app(folder)
-        resources = (
-            list(fastapi_app.state.resources.keys())
-            if hasattr(fastapi_app.state, "resources")
-            else []
-        )
-    except PermissionError:
-        console.print(f"\n  [red]error:[/red] permission denied: [bold]{folder}[/bold]")
-        console.print("[dim]check file permissions and try again[/dim]\n")
-        raise typer.Exit(1)
-    except Exception as e:
-        console.print(f"\n  [red]error:[/red] failed to load data: {e}\n")
-        raise typer.Exit(1)
-
-    # print startup banner
-    print_banner(host, port, resources, folder)
-
-    # run server
-    try:
-        uvicorn.run(fastapi_app, host=host, port=port, log_level="warning")
-    except KeyboardInterrupt:
-        console.print("\n  [dim]stopped[/dim]\n")
-    except OSError as e:
-        if "address already in use" in str(e).lower() or "10048" in str(e):
-            console.print(f"\n  [red]error:[/red] port {port} already in use")
-            console.print(f"  [dim]try: tc {path} -p {port + 1}[/dim]\n")
-        else:
-            console.print(f"\n  [red]error:[/red] {e}\n")
-        raise typer.Exit(1)
-
-
-@app.command()
-def version():
-    """show version"""
-    console.print("tinycontracts [cyan]v0.1.1[/cyan]")
-
-
-if __name__ == "__main__":
-    app()