Metadata-Version: 2.3
Name: kiln-generator
Version: 0.8.1
Summary: CLI for autogenerating files from templates
Keywords: cli,templates,code-generation,scaffolding
Author: Rodda John
Author-email: Rodda John <roddarjohn@protonmail.com>
License: MIT License
         
         Copyright (c) 2026 Rodda John
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.14
Classifier: Typing :: Typed
Requires-Dist: typer>=0.24.1
Requires-Dist: pydantic>=2.0
Requires-Dist: jsonnet>=0.21.0
Requires-Dist: jinja2>=3.0
Requires-Dist: fastapi>=0.115
Requires-Dist: sqlalchemy[asyncio]>=2.0
Requires-Dist: pyjwt>=2.0
Requires-Dist: pgqueuer[asyncpg]>=0.26.3
Requires-Dist: boto3>=1.34 ; extra == 'files'
Requires-Dist: opentelemetry-api==1.41.1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-sdk==1.41.1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-exporter-otlp-proto-http==1.41.1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-instrumentation-fastapi==0.62b1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-instrumentation-sqlalchemy==0.62b1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-instrumentation-requests==0.62b1 ; extra == 'opentelemetry'
Requires-Dist: opentelemetry-exporter-otlp-proto-grpc==1.41.1 ; extra == 'opentelemetry-grpc'
Requires-Python: >=3.14
Project-URL: Homepage, https://github.com/roddarjohn/kiln
Project-URL: Documentation, https://roddarjohn.github.io/kiln/
Project-URL: Repository, https://github.com/roddarjohn/kiln
Project-URL: Changelog, https://github.com/roddarjohn/kiln/blob/main/CHANGELOG.md
Project-URL: Issues, https://github.com/roddarjohn/kiln/issues
Provides-Extra: files
Provides-Extra: opentelemetry
Provides-Extra: opentelemetry-grpc
Description-Content-Type: text/markdown

# kiln

[![PyPI](https://img.shields.io/pypi/v/kiln-generator)](https://pypi.org/project/kiln-generator/)
[![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue)](https://roddarjohn.github.io/kiln/)

> **Pre-alpha** — kiln is under active development. APIs may change
> between releases. Feedback and contributions are welcome.

**CLI for autogenerating files from templates.**

---

## Install

```bash
pip install kiln-generator  # or: uv add kiln-generator
```

Optional extras:

```bash
pip install 'kiln-generator[files]'  # adds boto3 for S3 uploads
```

## Quick start

kiln registers itself as a target for the generic ``foundry`` CLI
(shipped in this same package):

```bash
foundry --help
foundry generate --config app.jsonnet
```

## Documentation

Full documentation is available at
[roddarjohn.github.io/kiln](https://roddarjohn.github.io/kiln/).
- [Usage](https://roddarjohn.github.io/kiln/usage.html)
- [API reference](https://roddarjohn.github.io/kiln/api.html)
- [Development guide](https://roddarjohn.github.io/kiln/development.html)

## Development

**Prerequisites:** [uv](https://docs.astral.sh/uv/), [just](https://just.systems), and `jsonnetfmt` — `brew install go-jsonnet` on macOS, `sudo apt install jsonnet` on Debian/Ubuntu.

```bash
# Clone and install
git clone https://github.com/<username>/kiln.git
cd kiln
uv sync --all-groups

# Install pre-commit hooks (ruff + jsonnetfmt run on every commit)
just setup

# Run checks
just lint          # ruff check + format
just type-check    # zuban check src/
just dev-test      # pytest (fast, local dev)
just test          # tox (full isolation)
just docs          # build Sphinx HTML docs
```

## License

See [LICENSE](LICENSE) for details.

## Future

- Authentication extensions
  - e.g. different permissions
  - e.g. permission actions
  - e.g. filter list endpoints
  - should be rego I'd think

- emails / texts / pdfs / spreadsheets?
  - is FE

- websockets?

- multi-tenant?
