| Name | python-lilypad JSON |
| Version |
0.0.8
JSON |
| download |
| home_page | None |
| Summary | An open-source prompt engineering framework. |
| upload_time | 2024-12-18 21:47:59 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.10 |
| license | MIT License Copyright (c) 2024 Mirascope 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. |
| keywords |
artificial intelligence
developer tools
evaluation
llm
llm tools
prompt engineering
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
# Lilypad
> [!WARNING]
> __Project is in alpha phase__
>
> This means that things like the user interface, database schemas, etc. are still subject to change. We do not yet recommend fully relying on this project in production, but we've found it works quite well for local development in its current stage.
An open-source prompt engineering framework built on these principles:
- Prompt engineering is an optimization process, which requires...
- Automatic versioning and tracing
- Developer-centric prompt template editor
- Proper syncing between prompts and code
> [!IMPORTANT]
> __We're looking for early design partners!__
>
> We are also working on tooling for improved collaboration between technical and non-technical team members. This is particularly important for involving domain experts who may not have the technical chops to contribute to a code base.
>
> If you're interested, [join our community](https://join.slack.com/t/mirascope-community/shared_invite/zt-2ilqhvmki-FB6LWluInUCkkjYD3oSjNA) and DM William Bakst :)
>
> There are limited spots.
## 30 Second Quickstart
Install Lilypad, specifying the provider(s) you intend to use, and set your API key:
```bash
pip install "python-lilypad[openai]"
export OPENAI_API_KEY=XXXXX
```
Create your first synced prompt to recommend a book.
For example, you could use the prompt `Recommend a fantasy book`:
```bash
lilypad start # initialize local project
lilypad create recommend_book # creates a synced LLM function
lilypad run recommend_book # runs the function (and opens editor)
```
Once you hit "Submit" you'll see the function run in your shell. Follow the link to see the version and trace in an interactive UI.
Next, try editing the function signature to take a `genre: str` argument. When you run the function again it will open the editor and give you access to the `{genre}` template variable (with autocomplete).
## Usage
We are actively working on this library and it's documentation, which you can find [here](https://lilypad.mirascope.com/docs)
## Versioning
Lilypad uses [Semantic Versioning](https://semver.org/)
## License
This project uses a dual-license model:
### Open-Source License (MIT)
Except for the contents and code contained in any `/ee` directory, which is covered by a commercial license (see below), all code in this repository is licensed under the terms of the [MIT License](https://github.com/Mirascope/lilypad/blob/main/LICENSE).
### Enterprise Edition License
The contents of any `/ee` directory are licensed under the Enterprise Edition License. This code is only available to users with a valid enterprise license. See [`lilypad/ee/LICENSE`](https://github.com/Mirascope/lilypad/blob/main/lilypad/ee/LICENSE) for the full terms.
__Enterprise Features:__
Stay tuned...
__Obtaining An Enterprise License:__
To purchase an enterprise license, please contact william@mirascope.io
__License Validation:__
Enterprise features require a valid license key for activation. Self-hosted installations will validate licenses against using offline activation.
Raw data
{
"_id": null,
"home_page": null,
"name": "python-lilypad",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.10",
"maintainer_email": "William Bakst <william@mirascope.io>",
"keywords": "artificial intelligence, developer tools, evaluation, llm, llm tools, prompt engineering",
"author": null,
"author_email": "William Bakst <william@mirascope.io>, Brendan Kao <brendan@mirascope.io>",
"download_url": "https://files.pythonhosted.org/packages/44/25/8f55a75ab3bf11d099d5a274fec2ef15d9a4db44790070466c938a4b93f7/python_lilypad-0.0.8.tar.gz",
"platform": null,
"description": "# Lilypad\n\n> [!WARNING]\n> __Project is in alpha phase__\n> \n> This means that things like the user interface, database schemas, etc. are still subject to change. We do not yet recommend fully relying on this project in production, but we've found it works quite well for local development in its current stage.\n\nAn open-source prompt engineering framework built on these principles:\n\n- Prompt engineering is an optimization process, which requires...\n- Automatic versioning and tracing\n- Developer-centric prompt template editor\n- Proper syncing between prompts and code\n\n> [!IMPORTANT]\n> __We're looking for early design partners!__\n> \n> We are also working on tooling for improved collaboration between technical and non-technical team members. This is particularly important for involving domain experts who may not have the technical chops to contribute to a code base.\n>\n> If you're interested, [join our community](https://join.slack.com/t/mirascope-community/shared_invite/zt-2ilqhvmki-FB6LWluInUCkkjYD3oSjNA) and DM William Bakst :)\n>\n> There are limited spots.\n\n## 30 Second Quickstart\n\nInstall Lilypad, specifying the provider(s) you intend to use, and set your API key:\n\n```bash\npip install \"python-lilypad[openai]\"\n\nexport OPENAI_API_KEY=XXXXX\n```\n\nCreate your first synced prompt to recommend a book.\n\nFor example, you could use the prompt `Recommend a fantasy book`:\n\n```bash\nlilypad start # initialize local project\nlilypad create recommend_book # creates a synced LLM function\nlilypad run recommend_book # runs the function (and opens editor)\n```\n\nOnce you hit \"Submit\" you'll see the function run in your shell. Follow the link to see the version and trace in an interactive UI.\n\nNext, try editing the function signature to take a `genre: str` argument. When you run the function again it will open the editor and give you access to the `{genre}` template variable (with autocomplete).\n\n## Usage\n\nWe are actively working on this library and it's documentation, which you can find [here](https://lilypad.mirascope.com/docs)\n\n## Versioning\n\nLilypad uses [Semantic Versioning](https://semver.org/)\n\n## License\n\nThis project uses a dual-license model:\n\n### Open-Source License (MIT)\n\nExcept for the contents and code contained in any `/ee` directory, which is covered by a commercial license (see below), all code in this repository is licensed under the terms of the [MIT License](https://github.com/Mirascope/lilypad/blob/main/LICENSE).\n\n### Enterprise Edition License\n\nThe contents of any `/ee` directory are licensed under the Enterprise Edition License. This code is only available to users with a valid enterprise license. See [`lilypad/ee/LICENSE`](https://github.com/Mirascope/lilypad/blob/main/lilypad/ee/LICENSE) for the full terms.\n\n__Enterprise Features:__\n\nStay tuned...\n\n__Obtaining An Enterprise License:__\n\nTo purchase an enterprise license, please contact william@mirascope.io\n\n__License Validation:__\n\nEnterprise features require a valid license key for activation. Self-hosted installations will validate licenses against using offline activation.\n",
"bugtrack_url": null,
"license": "MIT License Copyright (c) 2024 Mirascope 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.",
"summary": "An open-source prompt engineering framework.",
"version": "0.0.8",
"project_urls": {
"Changelog": "https://github.com/Mirascope/lilypad/releases",
"Documentation": "https://lilypad.so/docs",
"Homepage": "https://lilypad.so",
"Issues": "https://github.com/Mirascope/lilypad/issues",
"Repository": "https://github.com/Mirascope/lilypad"
},
"split_keywords": [
"artificial intelligence",
" developer tools",
" evaluation",
" llm",
" llm tools",
" prompt engineering"
],
"urls": [
{
"comment_text": null,
"digests": {
"blake2b_256": "44a943b9c061c41e76901b737278402b9b3477e7e84a0ede7f0774abff33c636",
"md5": "9cad7f030abf2986bca9f4fa08b28d4a",
"sha256": "bc596249f5cf3e8a64647d77159168dc3df79c6df3d98fb89ba76ba67cb22e3f"
},
"downloads": -1,
"filename": "python_lilypad-0.0.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9cad7f030abf2986bca9f4fa08b28d4a",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.10",
"size": 1054447,
"upload_time": "2024-12-18T21:47:56",
"upload_time_iso_8601": "2024-12-18T21:47:56.264780Z",
"url": "https://files.pythonhosted.org/packages/44/a9/43b9c061c41e76901b737278402b9b3477e7e84a0ede7f0774abff33c636/python_lilypad-0.0.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": null,
"digests": {
"blake2b_256": "44258f55a75ab3bf11d099d5a274fec2ef15d9a4db44790070466c938a4b93f7",
"md5": "8f9d642a8aa7a9961176093d6751e771",
"sha256": "e995c768714a482f471745b6799e6fed1e029c5e2de1d07321d6d1560daf3166"
},
"downloads": -1,
"filename": "python_lilypad-0.0.8.tar.gz",
"has_sig": false,
"md5_digest": "8f9d642a8aa7a9961176093d6751e771",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.10",
"size": 536467,
"upload_time": "2024-12-18T21:47:59",
"upload_time_iso_8601": "2024-12-18T21:47:59.110714Z",
"url": "https://files.pythonhosted.org/packages/44/25/8f55a75ab3bf11d099d5a274fec2ef15d9a4db44790070466c938a4b93f7/python_lilypad-0.0.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-12-18 21:47:59",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "Mirascope",
"github_project": "lilypad",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "python-lilypad"
}
