Metadata-Version: 2.1
Name: promplate
Version: 0.3.4
Summary: Prompt engineering framework for humans
Home-page: https://promplate.dev/
License: MIT
Keywords: prompt,template,nlp,llm
Author: Muspi Merol
Author-email: me@promplate.dev
Requires-Python: >=3.10,<4.0
Classifier: Development Status :: 5 - Production/Stable
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
Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
Classifier: Topic :: Text Processing :: Markup
Classifier: Typing :: Typed
Provides-Extra: aiofiles
Provides-Extra: all
Provides-Extra: httpx
Provides-Extra: openai
Requires-Dist: aiofiles (>=23.2,<24.0) ; extra == "aiofiles" or extra == "all"
Requires-Dist: httpx (>=0.24,<1.0) ; extra == "httpx" or extra == "all"
Requires-Dist: openai (>=0.27,<2.0) ; extra == "openai" or extra == "all"
Requires-Dist: typing-extensions (>=4,<5) ; python_version < "3.12"
Project-URL: Documentation, https://docs.py.promplate.dev/
Project-URL: Repository, https://github.com/promplate/core
Description-Content-Type: text/markdown

# Promplate

```text
</Promplate/> = <template> // prompt
```

**Promplate** is a prompting framework focusing on developing experience. However, it can also be a super-convenient SDK for simple LLM calls. Promplate progressively enhance your prompting workflow. And it values flexibility as well as perfect conventions. [Try online](https://promplate.dev/py)

## Installation

```shell
pip install promplate
```

**Promplate** supports both CPython and PyPy, from `3.8` to `3.12`. It even supports running in browsers through wasm implementations of python.

## Documentation

You can visit our official docs site at [docs.py.promplate.dev](https://docs.py.promplate.dev/).

## IDE Support 🌹

**Promplate** is fully typed, which means static type checker will find bugs correctly (if you use `pyright` for type checking).

We recommend using VS Code as your IDE when coding with promplate, because it natively uses pyright.

The language design of promplate is similar to `Jinja2`. So you can use the `.j2` file extension for template files for syntax highlight.

## Development

- use `poetry` to manage dependencies.
- use `isort` to sort import statements.
- use `black` to format code.
- use `pyright` to check type annotations.

Development should be done on `dev` branch, using `>=3.10` language features. The `master` branch is used for `py3.8` compatible releases.

**Promplate** is well tested with `pytest`. GitHub Actions are used to run tests and linting. And there are test results continually generated on [Vercel(py3.9)](https://promplate-core.vercel.app/) and [Netlify(py3.8)](https://promplate-core.netlify.app/). There is [a coverage report](https://promplate-python-coverage.onrender.com/) too.

## Future Features (or TODOs?)

- [ ] more documentation
- [ ] javascript implementation
- [ ] improve error handling
  - possible ways would be similar to [`Jinja2`](https://github.com/pallets/jinja/blob/main/src/jinja2/debug.py)

