Metadata-Version: 2.4
Name: datadict-cli
Version: 0.0.3
Summary: Command-line interface for building and managing DataDict projects
Author-email: Datadict Team <support@datadict.co>
License-Expression: MIT
Project-URL: Homepage, https://github.com/datadict-dev/datadict
Project-URL: Repository, https://github.com/datadict-dev/datadict
Project-URL: Issues, https://github.com/datadict-dev/datadict/issues
Project-URL: Documentation, https://github.com/datadict-dev/datadict
Keywords: datadict,data catalog,documentation,cli
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Information Technology
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Topic :: Database
Classifier: Topic :: Documentation
Classifier: Topic :: Utilities
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: pydantic<3.0.0,>=2.11.7
Requires-Dist: ruamel-yaml<0.19.0,>=0.18.15
Requires-Dist: click<9.0.0,>=8.2.1
Requires-Dist: rich<15.0.0,>=14.1.0
Requires-Dist: fastapi<0.117.0,>=0.116.1
Requires-Dist: uvicorn<0.36.0,>=0.35.0
Requires-Dist: httpx<0.29.0,>=0.28.1
Requires-Dist: requests<3.0.0,>=2.32.0
Requires-Dist: pandas<3.0.0,>=2.3.2
Requires-Dist: jinja2<4.0.0,>=3.1.0
Requires-Dist: pyyaml<7.0,>=6.0
Requires-Dist: datadict-connector-base>=0.0.1
Provides-Extra: dev
Requires-Dist: pytest>=8.4.1; extra == "dev"
Requires-Dist: ruff>=0.12.10; extra == "dev"
Dynamic: license-file

# DataDict CLI

This project is experimental and remains under heavy development. Expect rapid iteration and breaking changes while we refine the tooling.

## Preview a project

```bash
datadict preview --path ./my-project
```

This loads the project into SQLite and serves the bundled catalog UI and API at
`http://127.0.0.1:8000`. Restart preview after editing catalog YAML. Use `--host` and `--port` to
change the listener; preview is unauthenticated and should not be exposed publicly.

## Build for deployment

```bash
datadict build --path ./my-project
```

The command produces `my-project/build/datadict.db`. Deploy that artifact with the shared runtime
image described in [`deploy/README.md`](../../deploy/README.md); no static JSON site is generated.
