# 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.13`. 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
- [x] improved error handling
- display compiled code when error occurs through `linecache` or `tempfile` (default)
Raw data
{
"_id": null,
"home_page": "https://promplate.dev/",
"name": "promplate",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.10",
"maintainer_email": null,
"keywords": "prompt, template, nlp, llm",
"author": "Muspi Merol",
"author_email": "me@promplate.dev",
"download_url": "https://files.pythonhosted.org/packages/a2/2b/2933a9283420bb83d1f0d1aa0cf62a067f4e99f8fd7d898dcdbf4ca19a53/promplate-0.3.4.10.tar.gz",
"platform": null,
"description": "# Promplate\n\n```text\n</Promplate/> = <template> // prompt\n```\n\n**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)\n\n## Installation\n\n```shell\npip install promplate\n```\n\n**Promplate** supports both CPython and PyPy, from `3.8` to `3.13`. It even supports running in browsers through wasm implementations of python.\n\n## Documentation\n\nYou can visit our official docs site at [docs.py.promplate.dev](https://docs.py.promplate.dev/).\n\n## IDE Support \ud83c\udf39\n\n**Promplate** is fully typed, which means static type checker will find bugs correctly (if you use `pyright` for type checking).\n\nWe recommend using VS Code as your IDE when coding with promplate, because it natively uses pyright.\n\nThe language design of promplate is similar to `Jinja2`. So you can use the `.j2` file extension for template files for syntax highlight.\n\n## Development\n\n- use `poetry` to manage dependencies.\n- use `isort` to sort import statements.\n- use `black` to format code.\n- use `pyright` to check type annotations.\n\nDevelopment should be done on `dev` branch, using `>=3.10` language features. The `master` branch is used for `py3.8` compatible releases.\n\n**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.\n\n## Future Features (or TODOs?)\n\n- [ ] more documentation\n- [ ] javascript implementation\n- [x] improved error handling\n - display compiled code when error occurs through `linecache` or `tempfile` (default)\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Prompt engineering framework for humans",
"version": "0.3.4.10",
"project_urls": {
"Documentation": "https://docs.py.promplate.dev/",
"Homepage": "https://promplate.dev/",
"Repository": "https://github.com/promplate/core"
},
"split_keywords": [
"prompt",
" template",
" nlp",
" llm"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "16524a2fe01abed00a0908755479e5d15d19407c2a3bfcb46306fa715daa674d",
"md5": "7ec5ebea7da65d290476c7220778aa09",
"sha256": "9d15fbff6fa6b543f0d07dba4bc0f87048c661668ead4fa7dd91fb8c8d867c3d"
},
"downloads": -1,
"filename": "promplate-0.3.4.10-py3-none-any.whl",
"has_sig": false,
"md5_digest": "7ec5ebea7da65d290476c7220778aa09",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.10",
"size": 15830,
"upload_time": "2024-10-09T14:58:10",
"upload_time_iso_8601": "2024-10-09T14:58:10.100404Z",
"url": "https://files.pythonhosted.org/packages/16/52/4a2fe01abed00a0908755479e5d15d19407c2a3bfcb46306fa715daa674d/promplate-0.3.4.10-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "a22b2933a9283420bb83d1f0d1aa0cf62a067f4e99f8fd7d898dcdbf4ca19a53",
"md5": "f3e95383768198247899e07c005ca1d9",
"sha256": "37ecfa3d3a64afd229cd796dd4eeedb1479e61e314c51f9b0c625bbd7a045fec"
},
"downloads": -1,
"filename": "promplate-0.3.4.10.tar.gz",
"has_sig": false,
"md5_digest": "f3e95383768198247899e07c005ca1d9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.10",
"size": 12954,
"upload_time": "2024-10-09T14:58:11",
"upload_time_iso_8601": "2024-10-09T14:58:11.159194Z",
"url": "https://files.pythonhosted.org/packages/a2/2b/2933a9283420bb83d1f0d1aa0cf62a067f4e99f8fd7d898dcdbf4ca19a53/promplate-0.3.4.10.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-09 14:58:11",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "promplate",
"github_project": "core",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "promplate"
}
JSON
